The Cel JavaScript class. Adds file storage capabilities to cels.
More...
The Cel JavaScript class. Adds file storage capabilities to cels.
A cel JavaScript object can be obtained by calling render::frameReady()
◆ allocatedRect
QList<int> Cel::allocatedRect |
( |
| ) |
|
|
slot |
Retrieve allocated area of sparse image. Is equal to full area for non-sparse images.
- Returns
- Allocated rect. 4-tuple (x1, y1, width, height).
◆ convertColorSpace
bool Cel::convertColorSpace |
( |
String & |
fromColorSpace, |
|
|
String & |
toColorSpace |
|
) |
| |
|
slot |
Convert cel colour space.
- Parameters
-
fromColorSpace | the name of the colour space to convert from. |
toColorSpace | the name of the colour space to convert to. |
- Returns
- True if success, false if specified colour space names are not supported.
- See also
- render class
function frameReady(
frame, celImage)
{
celImage.convertColorSpace("Linear", "Rec.2020");
celImage.imageFile(
"c:/tmp/myimage" +
frame +
".png");
}
◆ imageFile [1/2]
Get a permanent copy of cel image file. This function without parameters is valid only for ports that point to a physically valid file on disk.
- Returns
- FileWrapper
◆ imageFile [2/2]
Get a permanent copy of cel image file of specific format.
- Parameters
-
name | Name of file to create |
- Returns
- FileWrapper
◆ imageFileAs
FileWrapper Cel::imageFileAs |
( |
String & |
name, |
|
|
String & |
formatstring, |
|
|
String & |
optionstring |
|
) |
| |
|
slot |
Get a permanent copy of cel image file of specific format.
- Parameters
-
name | Name of file to create |
formatstring | Format to convert image into |
optionstring | Image extension specific option (ie. TGA, TGA3, TGA4, SGIDP) |
- Returns
- FileWrapper
◆ isCel3D
◆ rect
Retrieve full area of image.
- Returns
- Full rect. 4-tuple (x1, y1, width, height).
◆ setEmpty
Set wrapped cel as empty.
◆ workingCopy
Get a temporary copy of cel image file.
- Returns
- FileWrapper
◆ workingCopyAs
FileWrapper Cel::workingCopyAs |
( |
String & |
ext, |
|
|
String & |
formatstring = String() , |
|
|
String & |
optionstring = String() |
|
) |
| |
|
slot |
Get a temporary copy of cel image file of specific format.
- Parameters
-
ext | Extension of image file to create |
formatstring | Format to convert image into |
optionstring | Image extension specific option |
- Returns
- FileWrapper