All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdStTextureUtils Class Reference

Helpers for loading textures. More...

Public Types

using ConversionFunction = void(*)(const void *src, size_t numTexels, void *dst)
 Converts given number of texels. More...
 

Static Public Member Functions

static HDST_API HgiFormat GetHgiFormat (HioFormat hioFormat, bool premultiplyAlpha)
 Get the Hgi format suitable for a given Hio format. More...
 
static HDST_API ConversionFunction GetHioToHgiConversion (HioFormat hioFormat, bool premultiplyAlpha)
 Returns the conversion function to return a HioFormat to the corresponding HgiFormat given by GetHgiFormat. More...
 
static HDST_API std::vector
< HioImageSharedPtr > 
GetAllMipImages (const std::string &filePath, HioImage::SourceColorSpace sourceColorSpace)
 Get all mip levels from a file. More...
 
static HDST_API GfVec3i ComputeDimensionsFromTargetMemory (const std::vector< HioImageSharedPtr > &mips, HgiFormat targetFormat, size_t tileCount, size_t targetMemory, size_t *mipIndex=nullptr)
 
static HDST_API bool ReadAndConvertImage (HioImageSharedPtr const &image, bool flipped, bool premultiplyAlpha, const HgiMipInfo &mipInfo, size_t layer, void *bufferStart)
 

Detailed Description

Helpers for loading textures.

Definition at line 42 of file textureUtils.h.

Member Typedef Documentation

using ConversionFunction = void(*)(const void * src, size_t numTexels, void * dst)

Converts given number of texels.

Conversion can be in-place if the ends of the source and destination buffers align.

Definition at line 52 of file textureUtils.h.

Member Function Documentation

static HDST_API std::vector<HioImageSharedPtr> GetAllMipImages ( const std::string &  filePath,
HioImage::SourceColorSpace  sourceColorSpace 
)
static

Get all mip levels from a file.

static HDST_API HgiFormat GetHgiFormat ( HioFormat  hioFormat,
bool  premultiplyAlpha 
)
static

Get the Hgi format suitable for a given Hio format.

Premultiply alpha indicates whether a conversion function multiplying RGB with alpha should be created.

static HDST_API ConversionFunction GetHioToHgiConversion ( HioFormat  hioFormat,
bool  premultiplyAlpha 
)
static

Returns the conversion function to return a HioFormat to the corresponding HgiFormat given by GetHgiFormat.

Returns nullptr if no conversion necessary.


The documentation for this class was generated from the following file: