![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
The IImage resource object interface.
An image resource holds a (possibly compressed) bitmap image in one of the available image formats, such as PNG, JPG etc.
Get the texture type represented by the image.
Murl.IEnums.TextureType GetTextureType()
Get the number of individual image streams.
Integer GetNumberOfStreams()
Get the number of image layers. For non-array images, this always returns 1.
Integer GetNumberOfLayers()
Get the number of image faces. For flat images or arrays, this always returns 1. For cubemap images or arrays, this returns 6.
Integer GetNumberOfFaces()
Get the stream index for a given layer and face index.
Integer GetStreamIndex(Integer layerIndex, Integer faceIndex)
layerIndex | The layer index, from 0 to GetNumberOfLayers()-1. |
faceIndex | The face index, from 0 to GetNumberOfFaces()-1. |
Get the number of actual MIP levels stored in the image resource.
Integer GetNumberOfMipLevels(Integer streamIndex)
streamIndex | The index of the stream, from 0 to GetNumberOfStreams()-1. |
Get the image's horizontal size in pixels, at the base MIP level.
Integer GetPixelSizeX(Integer streamIndex)
streamIndex | The index of the stream, from 0 to GetNumberOfStreams()-1. |
Get the image's vertical size in pixels, at the base MIP level.
Integer GetPixelSizeY(Integer streamIndex)
streamIndex | The index of the stream, from 0 to GetNumberOfStreams()-1. |
Get the image's native pixel format.
Murl.IEnums.PixelFormat GetNativePixelFormat(Integer streamIndex)
streamIndex | The index of the stream, from 0 to GetNumberOfStreams()-1. |
Get the image's preferred pixel format. If the given image has no actual preference for the format used, this method returns IEnums::PIXEL_FORMAT_UNDEFINED. Otherwise, a specific format is returned.
Murl.IEnums.PixelFormat GetPreferredPixelFormat(Integer streamIndex)
streamIndex | The index of the stream, from 0 to GetNumberOfStreams()-1. |
Get the image's forced pixel format, when no conversion is available. If a pixel format converter is available that can convert the image's native format to some other format, this method should return IEnums::PIXEL_FORMAT_UNDEFINED. Otherwise, a specific format is returned. This is usually the case for images using some compressed format like ETC1, PVRTC or similar.
Murl.IEnums.PixelFormat GetForcedPixelFormat(Integer streamIndex)
streamIndex | The index of the stream, from 0 to GetNumberOfStreams()-1. |
Get the image's actual format.
Murl.IEnums.VideoStreamFormat GetVideoStreamFormat(Integer streamIndex)
streamIndex | The index of the stream, from 0 to GetNumberOfStreams()-1. |
Create an IVideoStream object from the resource, with default pixel format and size.
Murl.IVideoStream CreateStream(Integer streamIndex, Murl.IEnums.MipMapGenerationMode mipMapGen)
streamIndex | The index of the stream, from 0 to GetNumberOfStreams()-1. |
mipMapGen | The MIP map generation mode. |
Create an IVideoStream object from the resource, with custom pixel format and size.
Murl.IVideoStream CreateStream(Integer streamIndex, Murl.IEnums.PixelFormat pixelFormat, Integer pixelSizeX, Integer pixelSizeY, Integer divisor, Murl.IEnums.MipMapGenerationMode mipMapGen)
streamIndex | The index of the stream, from 0 to GetNumberOfStreams()-1. |
pixelFormat | The desired pixel format. |
pixelSizeX | The horizontal size of the stream in pixels, at the base MIP level. |
pixelSizeY | The vertical size of the stream in pixels, at the base MIP level. |
divisor | An optional power-of-two prescale factor (use 1 for a 1:1 image). |
mipMapGen | The MIP map generation mode. |
Create a default binary encoded image.
Boolean, Murl.Data CreateDefaultBinary(Murl.Data data)
data | The Data object to receive the encoded image. |
Create a binary encoded image, explicit stream and pixel formats and size.
Boolean, Murl.Data CreateBinary(Murl.Data data, Murl.IEnums.VideoStreamFormat streamFormat, Murl.IEnums.PixelFormat pixelFormat, Integer sizeX, Integer sizeY)
data | The Data object to receive the encoded image. |
streamFormat | The stream format to use. |
pixelFormat | The pixel format to use. |
sizeX | The width in pixels, or 0 to encode the image using its original width. |
sizeY | The height in pixels, or 0 to encode the image using its original height. |