![]() |
Python Script Engine
7.2
GL Studio Editor Python Script API
|
Public Types | |
enum | ImageCompression { IMAGE_COMPRESSION_RAW, IMAGE_COMPRESSION_LZ77, IMAGE_COMPRESSION_JPEG } |
Public Member Functions | |
String | __repr__ (void) |
bool | isNULL () |
String | GetFilename () |
void | SetFilename (String name) |
int | GetSourceImageWidth () |
int | GetSourceImageHeight () |
int | GetSourceImageMemorySize () |
int | GetGeneratedImageWidth () |
int | GetGeneratedImageHeight () |
int | GetGeneratedImageMemorySize () |
int | GetGeneratedImageDiskSize () |
void | Reload () |
void | Replace (String filename) |
void | SetInvertAlphaTransparency (bool invertAlphaTransparency) |
bool | IsInvertAlphaTransparency () |
void | SetGenerateAsInlineData (bool generateAsInlineData) |
bool | IsGenerateAsInlineData () |
void | SetUseHardwareCompression (bool useHardwareCompression) |
bool | IsUseHardwareCompression () |
void | SetImageCompression (ImageCompression imageCompression) |
ImageCompression | GetImageCompression () |
void | SetJPEGImageQuality (int imageQuality) |
int | GetJPEGImageQuality () |
void | SetDownsize (int downsize) |
int | GetDownsize () |
int | GetTextureIndex () |
Python engine extension for the TexturePaletteEntry editor object.
If the TexturePaletteEntry instance is null, or has been deleted from the document's TexturePalette , it will return 'False' in comparison checks.
String TexturePaletteEntry::__repr__ | ( | void | ) |
repr function (python function to return a string representation of the object)
int TexturePaletteEntry::GetDownsize | ( | ) |
Get the downsize factor.
String TexturePaletteEntry::GetFilename | ( | ) |
Get the filename associated with this entry.
int TexturePaletteEntry::GetGeneratedImageDiskSize | ( | ) |
Get the size in bytes on disk of the generated image.
int TexturePaletteEntry::GetGeneratedImageHeight | ( | ) |
Get the generated height of the image.
int TexturePaletteEntry::GetGeneratedImageMemorySize | ( | ) |
Get the memory size in bytes of the generated image.
int TexturePaletteEntry::GetGeneratedImageWidth | ( | ) |
Get the generated width of the image.
ImageCompression TexturePaletteEntry::GetImageCompression | ( | ) |
Get the image compresssion mode.
int TexturePaletteEntry::GetJPEGImageQuality | ( | ) |
Get the JPEG image quality.
int TexturePaletteEntry::GetSourceImageHeight | ( | ) |
Get the height of the source image.
int TexturePaletteEntry::GetSourceImageMemorySize | ( | ) |
Get the memory size in bytes of the source image.
int TexturePaletteEntry::GetSourceImageWidth | ( | ) |
Get the width of the source image.
int TexturePaletteEntry::GetTextureIndex | ( | ) |
Get the index of this texture entry in the texture palette.
bool TexturePaletteEntry::IsGenerateAsInlineData | ( | ) |
Get the generate as inline data mode.
bool TexturePaletteEntry::IsInvertAlphaTransparency | ( | ) |
Get the invert alpha transparency mode.
bool TexturePaletteEntry::isNULL | ( | ) |
Determine if wrapped texture palette entry does not exist.
bool TexturePaletteEntry::IsUseHardwareCompression | ( | ) |
Get the use hardware compression mode.
void TexturePaletteEntry::Reload | ( | ) |
Reload the texture for this entry.
void TexturePaletteEntry::Replace | ( | String | filename | ) |
Replace the texture for this entry.
filename | file path and name of texture to use as replacement (can be relative or absolute) |
void TexturePaletteEntry::SetDownsize | ( | int | downsize | ) |
Set the downsize factor (NOTE: the downsizing will be clamped to its logical maximum)
downsize | (must be >0 and a power of 2) if 1 then no downsizing else image width and height are divided by downsize (i.e. downsize 2 gives an image half the width and height) |
void TexturePaletteEntry::SetFilename | ( | String | name | ) |
Set the filename of the TexturePaletteEntry.
name | the new filename of the entry |
void TexturePaletteEntry::SetGenerateAsInlineData | ( | bool | generateAsInlineData | ) |
Set the generate as inline data mode.
generateAsInlineData | true to generate as inline data |
void TexturePaletteEntry::SetImageCompression | ( | ImageCompression | imageCompression | ) |
Set the image compresssion mode.
imageCompression | image compression mode NOTE: mode will be set to IMAGE_COMPRESSION_LZ77 if IMAGE_COMPRESSION_JPEG is selected but image is too small for JPEG compression |
void TexturePaletteEntry::SetInvertAlphaTransparency | ( | bool | invertAlphaTransparency | ) |
Set the invert alpha transparency mode.
invertAlphaTransparency | true to invert alpha transparency |
void TexturePaletteEntry::SetJPEGImageQuality | ( | int | imageQuality | ) |
Set the JPEG image quality.
imageQuality | image quality |
void TexturePaletteEntry::SetUseHardwareCompression | ( | bool | useHardwareCompression | ) |
Set the use hardware compression mode.
useHardwareCompression | true to use hardware compression |