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

Opaque reference to a texture stored in the RV_TextureCache. More...

#include <RV_Type.h>

Classes

struct  CacheData
 

Public Member Functions

 ~RV_TextureRef ()
 
bool isValid () const
 Reference to a valid texture. More...
 
bool isPlaceholder () const
 Texture is missing; a default color used instead. More...
 
bool isMissingTex () const
 Texture couldn't be found or resolved. More...
 
bool isLoading () const
 Texture is currently loading in the background. More...
 
bool isDirty () const
 Texture has been changed since last check. More...
 
void reset ()
 Reset the reference to a null handle. More...
 
bool isUDIM () const
 Returns true if the reference is to a series of UDIM texture files. More...
 
void getUDIMParms (int &x, int &y, int &w, int &h) const
 Returns the UDIM range of the texture files (eg. (0,0) -> (3,2)) More...
 
void getRes (int *w, int *h=nullptr, int *d=nullptr) const
 
RV_ImageDim getImageDim () const
 Returns texture dimension. More...
 
exint id () const
 

Friends

class RV_TextureCache
 

Detailed Description

Opaque reference to a texture stored in the RV_TextureCache.

Definition at line 203 of file RV_Type.h.

Constructor & Destructor Documentation

RV_TextureRef::~RV_TextureRef ( )
inline

Definition at line 206 of file RV_Type.h.

Member Function Documentation

RV_ImageDim RV_TextureRef::getImageDim ( ) const
inline

Returns texture dimension.

Definition at line 259 of file RV_Type.h.

void RV_TextureRef::getRes ( int w,
int h = nullptr,
int d = nullptr 
) const
inline

Definition at line 248 of file RV_Type.h.

void RV_TextureRef::getUDIMParms ( int x,
int y,
int w,
int h 
) const
inline

Returns the UDIM range of the texture files (eg. (0,0) -> (3,2))

Definition at line 240 of file RV_Type.h.

exint RV_TextureRef::id ( ) const
inline

Definition at line 261 of file RV_Type.h.

bool RV_TextureRef::isDirty ( ) const
inline

Texture has been changed since last check.

Definition at line 222 of file RV_Type.h.

bool RV_TextureRef::isLoading ( ) const
inline

Texture is currently loading in the background.

Definition at line 219 of file RV_Type.h.

bool RV_TextureRef::isMissingTex ( ) const
inline

Texture couldn't be found or resolved.

Definition at line 216 of file RV_Type.h.

bool RV_TextureRef::isPlaceholder ( ) const
inline

Texture is missing; a default color used instead.

Definition at line 213 of file RV_Type.h.

bool RV_TextureRef::isUDIM ( ) const
inline

Returns true if the reference is to a series of UDIM texture files.

Definition at line 238 of file RV_Type.h.

bool RV_TextureRef::isValid ( ) const
inline

Reference to a valid texture.

Definition at line 209 of file RV_Type.h.

void RV_TextureRef::reset ( void  )
inline

Reset the reference to a null handle.

Definition at line 226 of file RV_Type.h.

Friends And Related Function Documentation

friend class RV_TextureCache
friend

Definition at line 292 of file RV_Type.h.


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