cohtml::IAsyncResourceResponse::UserImageData
Description of the properties of the user provided image.
#include <ResourceHandler.h>
Public Types
| Name | |
|---|---|
| enum | TextureFilteringMode { FilterPoint, FilterLinear} Enumeration with the available texture filtering modes for user images. |
| enum | AlphaPremultiplicationMode { Premultiplied, NonPremultiplied} Enumeration with the available alpha premultiplication modes. Used for the renderer pipeline state (blend modes) when drawing. |
Public Functions
| Name | |
|---|---|
| UserImageData() |
Public Attributes
| Name | |
|---|---|
| unsigned | Width |
| unsigned | Height |
| unsigned | ContentRectX |
| unsigned | ContentRectY |
| unsigned | ContentRectWidth |
| unsigned | ContentRectHeight |
| unsigned | ImageHandle Set to a unique ID value greater than 0 to make image a live view. |
| unsigned | SystemOwnerId |
| unsigned | MipsCount |
| renoir::ImageOrigin | Origin |
| renoir::PixelFormat | Format |
| void * | TextureBatchingHint Pointer to a user-defined identifier that will be used to identify user images belonging to the same texture. User images sharing the same TextureBatchingHint will leave only a single image’s memory footprint inside the GPU Memory Tracker. Draws using different user images that share the same TextureBatchingHint can be batched together in a single draw call even when the Texture pointer is different. |
| void * | Texture Pointer to a user-defined user data of the texture. Will be passed as-is to the graphics backend. Draws using different user images that share the same Texture pointer can be batched together in a single draw call. |
| TextureFilteringMode | TextureFiltering Requests a specific filtering type for this user image. |
| AlphaPremultiplicationMode | AlphaPremultiplication Whether alpha is premultiplied in the image. |
Public Types Documentation
enum TextureFilteringMode
| Enumerator | Value | Description |
|---|---|---|
| FilterPoint | Point texture sampling (Nearest-neighbor) | |
| FilterLinear | Bilinear texture filtering. |
Enumeration with the available texture filtering modes for user images.
enum AlphaPremultiplicationMode
| Enumerator | Value | Description |
|---|---|---|
| Premultiplied | Alpha is premultiplied in the color channels. | |
| NonPremultiplied | Alpha is not premultiplied, it’s independent of the color channels. |
Enumeration with the available alpha premultiplication modes. Used for the renderer pipeline state (blend modes) when drawing.
Public Functions Documentation
function UserImageData
inline UserImageData()
Public Attributes Documentation
variable Width
unsigned Width;
variable Height
unsigned Height;
variable ContentRectX
unsigned ContentRectX;
variable ContentRectY
unsigned ContentRectY;
variable ContentRectWidth
unsigned ContentRectWidth;
variable ContentRectHeight
unsigned ContentRectHeight;
variable ImageHandle
unsigned ImageHandle;
Set to a unique ID value greater than 0 to make image a live view.
variable SystemOwnerId
unsigned SystemOwnerId;
variable MipsCount
unsigned MipsCount;
variable Origin
renoir::ImageOrigin Origin;
variable Format
renoir::PixelFormat Format;
variable TextureBatchingHint
void * TextureBatchingHint;
Pointer to a user-defined identifier that will be used to identify user images belonging to the same texture. User images sharing the same TextureBatchingHint will leave only a single image’s memory footprint inside the GPU Memory Tracker. Draws using different user images that share the same TextureBatchingHint can be batched together in a single draw call even when the Texture pointer is different.
variable Texture
void * Texture;
Pointer to a user-defined user data of the texture. Will be passed as-is to the graphics backend. Draws using different user images that share the same Texture pointer can be batched together in a single draw call.
variable TextureFiltering
TextureFilteringMode TextureFiltering;
Requests a specific filtering type for this user image.
variable AlphaPremultiplication
AlphaPremultiplicationMode AlphaPremultiplication;
Whether alpha is premultiplied in the image.