The abstract base class for an image resource. More...
#include "murl_resource_image.h"
Additional Inherited Members | |
 Public Types inherited from Murl::IFactoryObject< IObject > | |
| using | ClassInfoArray = Array< const ClassInfo * > |
| Definition of an array of ClassInfo objects. | |
| Public Member Functions inherited from Murl::Resource::IObject | |
| virtual Bool | GetFileDependencies (Array< String > &fileNames) const =0 |
| Fill a given string array with names of files the resource depends on. More... | |
| Public Member Functions inherited from Murl::IFactoryObject< IObject > | |
| ~IFactoryObject () override | |
| The destructor. | |
| virtual const ClassInfo * | GetObjectClassInfo () const=0 |
| Get the object instance's class info, if present. More... | |
| virtual void | ResetObjectProperties ()=0 |
| Reset the object instance's properties to their default values. | |
| Public Member Functions inherited from Murl::Resource::IImage | |
| virtual IObject * | GetObjectInterface ()=0 |
| Get the mutable Resource::IObject interface. More... | |
| virtual const IObject * | GetObjectInterface () const =0 |
| Get the constant Resource::IObject interface. More... | |
| virtual UInt32 | GetPixelSizeX (UInt32 streamIndex) const =0 |
| Get the image's horizontal size in pixels, at the base MIP level. More... | |
| virtual UInt32 | GetPixelSizeY (UInt32 streamIndex) const =0 |
| Get the image's vertical size in pixels, at the base MIP level. More... | |
| virtual IEnums::PixelFormat | GetNativePixelFormat (UInt32 streamIndex) const =0 |
| Get the image's native pixel format. More... | |
| virtual IEnums::PixelFormat | GetPreferredPixelFormat (UInt32 streamIndex) const =0 |
| Get the image's preferred pixel format. More... | |
| virtual IEnums::PixelFormat | GetForcedPixelFormat (UInt32 streamIndex) const =0 |
| Get the image's forced pixel format, when no conversion is available. More... | |
| virtual IEnums::VideoStreamFormat | GetVideoStreamFormat (UInt32 streamIndex) const =0 |
| Get the image's actual format. More... | |
| virtual IVideoStream * | CreateStream (UInt32 streamIndex, IEnums::MipMapGenerationMode mipMapGen) const =0 |
| Create an IVideoStream object from the resource, with default pixel format and size. More... | |
| virtual IVideoStream * | CreateStream (UInt32 streamIndex, IEnums::PixelFormat pixelFormat, UInt32 pixelSizeX, UInt32 pixelSizeY, UInt32 divisor, IEnums::MipMapGenerationMode mipMapGen) const =0 |
| Create an IVideoStream object from the resource, with custom pixel format and size. More... | |
| Static Public Member Functions inherited from Murl::IFactoryObject< IObject > | |
| static const PropertyInfo * | GetPropertyInfo () |
| Get the class' property info struct. More... | |
| static const AttributeInfo * | GetAttributeInfo () |
| Get the class' attribute info struct. More... | |
| static void | ResetProperties (IFactoryObject< IObject > *object) |
| Reset an object instance's properties to their default values. More... | |
Detailed Description
The abstract base class for an image resource.
XML Elements
- XML Resource Object Attributes:
-
outputStreamFormat="DEFAULT" [IEnums::VideoStreamFormat]
The optional output stream format. If the format is set to some specific value (e.g. "PNG" or "WEBP"), the given image is encoded using that format when it is included in a binary resource package using the resource_packer tool, otherwise the input format is used. Note, that the image is NOT re-encoded during loading, to maintain reasonable loading time of a package. This has the effect that, when e.g. recoding a PNG image as JPG, any possible visual artifacts due to the lossy nature of the output format are only visible when loading the binary package. Note also that not all input formats (such as ETC1 or PVRTC) allow for recoding to a different format.
outputPixelFormat="DEFAULT" [IEnums::PixelFormat]
The optional output pixel format. If the pixel format is set to some specific value, the resource packer tool tries to re-encode the given image using that format, if possible. See also the outputStreamFormat attribute above.
outputCompressionType="DEFAULT" [IEnums::CompressionType]
The optional output compression type. Supported by the "WEBP" outputStreamFormat, this attribute specifies which compression type to use, either "LOSSLESS" or "LOSSY". Supported by the "PNG" outputStreamFormat, this attribute specifies which compression type to use, either "DEFAULT" or "BEST".
outputCompressionQuality="90.0" [Real]
The optional output compression quality/size, in the range from 0.0 (lowest/smallest) to 100.0 (highest/largest). Currently only supported by the "WEBP" outputStreamFormat, this attribute specifies the actual compression qualits if "LOSSY" is specified for outputCompressionType.
The documentation for this class was generated from the following file:
- murl_resource_image.h