1.9.5.4
Prysm
cohtml::IAsyncResourceResponse::UserImageData Struct Reference

Description of the properties of the user provided image. More...

Public Types

enum  TextureFilteringMode { FilterPoint, FilterLinear }
 Enumeration with the available texture filtering modes for user images. More...
 
enum  AlphaPremultiplicationMode { Premultiplied, NonPremultiplied }
 Enumeration with the available alpha premultiplication modes. Used for the renderer pipeline state (blend modes) when drawing. More...
 

Public Member Functions

 UserImageData ()
 

Public Attributes

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. More...
 
unsigned SystemOwnerId
 
renoir::ImageOrigin Origin
 
renoir::PixelFormat Format
 
void * TextureBatchingHint
 Pointer to a user-defined identifier that will be used to identify textures belonging to the same atlas. Draws using different Images that share the same TextureBatching can be batched together. More...
 
void * Texture
 Pointer to a user-defined representation of the texture. Will be passed as-is to the graphics backend. More...
 
TextureFilteringMode TextureFiltering
 Requests a specific filtering type for this user image. More...
 
AlphaPremultiplicationMode AlphaPremultiplication
 Whether alpha is premultiplied in the image. More...
 

Detailed Description

Description of the properties of the user provided image.

Member Enumeration Documentation

◆ AlphaPremultiplicationMode

Enumeration with the available alpha premultiplication modes. Used for the renderer pipeline state (blend modes) when drawing.

Enumerator
Premultiplied 

Alpha is premultiplied in the color channels.

NonPremultiplied 

Alpha is not premultiplied, it's independent of the color channels.

◆ TextureFilteringMode

Enumeration with the available texture filtering modes for user images.

Enumerator
FilterPoint 

Point texture sampling (Nearest-neighbor)

FilterLinear 

Bilinear texture filtering.

Constructor & Destructor Documentation

◆ UserImageData()

cohtml::IAsyncResourceResponse::UserImageData::UserImageData ( )
inline

Member Data Documentation

◆ AlphaPremultiplication

AlphaPremultiplicationMode cohtml::IAsyncResourceResponse::UserImageData::AlphaPremultiplication

Whether alpha is premultiplied in the image.

◆ ContentRectHeight

unsigned cohtml::IAsyncResourceResponse::UserImageData::ContentRectHeight

◆ ContentRectWidth

unsigned cohtml::IAsyncResourceResponse::UserImageData::ContentRectWidth

◆ ContentRectX

unsigned cohtml::IAsyncResourceResponse::UserImageData::ContentRectX

◆ ContentRectY

unsigned cohtml::IAsyncResourceResponse::UserImageData::ContentRectY

◆ Format

renoir::PixelFormat cohtml::IAsyncResourceResponse::UserImageData::Format

◆ Height

unsigned cohtml::IAsyncResourceResponse::UserImageData::Height

◆ ImageHandle

unsigned cohtml::IAsyncResourceResponse::UserImageData::ImageHandle

Set to a unique ID value greater than 0 to make image a live view.

◆ Origin

renoir::ImageOrigin cohtml::IAsyncResourceResponse::UserImageData::Origin

◆ SystemOwnerId

unsigned cohtml::IAsyncResourceResponse::UserImageData::SystemOwnerId

◆ Texture

void* cohtml::IAsyncResourceResponse::UserImageData::Texture

Pointer to a user-defined representation of the texture. Will be passed as-is to the graphics backend.

◆ TextureBatchingHint

void* cohtml::IAsyncResourceResponse::UserImageData::TextureBatchingHint

Pointer to a user-defined identifier that will be used to identify textures belonging to the same atlas. Draws using different Images that share the same TextureBatching can be batched together.

◆ TextureFiltering

TextureFilteringMode cohtml::IAsyncResourceResponse::UserImageData::TextureFiltering

Requests a specific filtering type for this user image.

◆ Width

unsigned cohtml::IAsyncResourceResponse::UserImageData::Width