Unit CastleTextureImages
Description
Handling of images for textures. This unit is not OpenGL-specific, it should be suitable for all 3D libraries. See CastleGLImage for OpenGL-specific handling of textures and other images.
Texture is any TEncodedImage instance. This includes not only a traditional 2D/3D matrix of pixels represented as TCastleImage, but also a texture compressed for GPU (TGPUCompressedImage). Moreover, a texture may have mipmaps defined — they are stored inside TCompositeImage instance (that contains a list of TEncodedImage).
Since not everything can really deal with such flexible definition of a texture, we decided to separate some routines specifically for textures. For example, you have LoadTextureImage to load full texture information — contrast this with LoadImage routine in CastleImages unit, that only returns TCastleImage (a "normal" way to deal with image data).
Source: images/castletextureimages.pas (line 31).
Uses
- Generics.Collections
- CastleImages
- CastleInternalCompositeImage
- CastleUtils
- CastleVideos
- CastleRenderOptions
Overview
Classes, Interfaces, Objects and Records
| Name | Description |
|---|---|
Class TTexturesVideosCache |
A cache of loaded images for textures. |
Functions and Procedures
function LoadTextureImage(const Url: String; out Composite: TCompositeImage; const LoadOptions: TLoadImageOptions = []): TEncodedImage; overload; |
function LoadTextureImage(const Url: String; const LoadOptions: TLoadImageOptions = []): TEncodedImage; overload; |
Constants
Variables
LogTextureCache: boolean = false; |
TextureCache: TTexturesVideosCache; |
TextureLoadingScale: Cardinal = 1; |
Description
Functions and Procedures
function LoadTextureImage(const Url: String; out Composite: TCompositeImage; const LoadOptions: TLoadImageOptions = []): TEncodedImage; overload; |
|
Load image suitable for a texture. This will load image to memory formats supported by common 3D libraries (like OpenGL), for example it will never return TRGBFloatImage (although OpenGL may support it, but we cannot be sure at this point). It may return texture compressed using one of the GPU compression algorithms (see TTextureCompression). If the image comes from a TCompositeImage file (DDS, KTX...), it will also return it (if not, Composite returned will be Overloaded version without Composite parameter assumes you're not interested in this information (still it handles Composite files of course, it just doesn't return Composite object instance). |
function LoadTextureImage(const Url: String; const LoadOptions: TLoadImageOptions = []): TEncodedImage; overload; |
|
This item has no description. |
Constants
TextureImageClasses: array [0..3] of TEncodedImageClass = (
TRGBImage,
TRGBAlphaImage,
TGrayscaleImage,
TGrayscaleAlphaImage
); |
|
Image classes that are handled by absolutely all OpenGL versions. |
TextureImageClassesAll: array [0..8] of TEncodedImageClass = (
TRGBImage,
TRGBAlphaImage,
TGrayscaleImage,
TGrayscaleAlphaImage,
TGPUCompressedImage,
TGrayscaleFloatImage,
TGrayscaleAlphaFloatImage,
TRGBFloatImage,
TRGBAlphaFloatImage
); |
|
All image classes that may be handled by OpenGL. Some of them may require specific OpenGL extensions or versions (like GPU-compressed or float textures). |
minNearest = CastleRenderOptions.minNearest; |
|
We recommend using CastleRenderOptions unit to get these constants. But for backward compatibility, they are also available here. |
minLinear = CastleRenderOptions.minLinear; |
|
This item has no description. |
minNearestMipmapNearest = CastleRenderOptions.minNearestMipmapNearest; |
|
This item has no description. |
minNearestMipmapLinear = CastleRenderOptions.minNearestMipmapLinear; |
|
This item has no description. |
minLinearMipmapNearest = CastleRenderOptions.minLinearMipmapNearest; |
|
This item has no description. |
minLinearMipmapLinear = CastleRenderOptions.minLinearMipmapLinear; |
|
This item has no description. |
minDefault = CastleRenderOptions.minDefault; |
|
This item has no description. |
minFastest = CastleRenderOptions.minFastest; |
|
This item has no description. |
minNicest = CastleRenderOptions.minNicest; |
|
This item has no description. |
magNearest = CastleRenderOptions.magNearest; |
|
This item has no description. |
magLinear = CastleRenderOptions.magLinear; |
|
This item has no description. |
magDefault = CastleRenderOptions.magDefault; |
|
This item has no description. |
magFastest = CastleRenderOptions.magFastest; |
|
This item has no description. |
magNicest = CastleRenderOptions.magNicest; |
|
This item has no description. |
DefaultSpriteSheetFramesPerSecond = 8.0; |
|
Default frame per second for Sprite Sheet animations like Starling and Cocos2d. |
Variables
LogTextureCache: boolean = false; |
|
Log texture cache events. Allows to see how the cache performs, and also how alpha channel is detected. A lot of log messages. Meaningful only if you initialized log (see CastleLog unit) by InitializeLog first. |
TextureCache: TTexturesVideosCache; |
|
Cache of texture images, equal to X3DCache and automatically initialized / finalized if you use X3DNodes unit. |
TextureLoadingScale: Cardinal = 1; |
|
Use the auto-generated alternative downscaled images. This allows to conserve both GPU memory and loading time by using a downscaled images versions. The subset of your images which are affected by this must be declared inside the material_properties.xml file. And the image files must be prepared earlier by the build tool call Each size (width, height, and (for 3D images) depth) is scaled by This mechanism will not automatically downscale textures at runtime. If the downscaled texture version should exist, according to the material_properties.xml file, but it doesn't, then texture loading will simply fail. If you want to scale the texture at runtime, use the similar GLTextureScale instead. This mechanism is independent from GLTextureScale:
|
Generated by PasDoc 0.17.0.snapshot.