RV_TextureRef Class Reference

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

#include <RV_TextureRef.h>

Classes
struct	CacheData

Public Member Functions
	RV_TextureRef ()=default
	RV_TextureRef (const RV_TextureRef &other)
	~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...
fpreal	getImageAspectRatio () const
exint	id () const
RV_TextureRef &	operator= (const RV_TextureRef &other)
int	getChannels () const
int	getTypeInfo () const

Friends
class	RV_TextureCache

Detailed Description

Opaque reference to a texture stored in the RV_TextureCache.

Definition at line 21 of file RV_TextureRef.h.

Constructor & Destructor Documentation

RV_TextureRef::RV_TextureRef ( )

default

RV_TextureRef::RV_TextureRef ( const RV_TextureRef &  other )

inline

Definition at line 25 of file RV_TextureRef.h.

RV_TextureRef::~RV_TextureRef ( )

inline

Definition at line 26 of file RV_TextureRef.h.

Member Function Documentation

int RV_TextureRef::getChannels ( ) const

inline

Definition at line 130 of file RV_TextureRef.h.

fpreal RV_TextureRef::getImageAspectRatio ( ) const

inline

Definition at line 81 of file RV_TextureRef.h.

RV_ImageDim RV_TextureRef::getImageDim ( ) const

inline

Returns texture dimension.

Definition at line 80 of file RV_TextureRef.h.

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

inline

Definition at line 69 of file RV_TextureRef.h.

int RV_TextureRef::getTypeInfo ( ) const

inline

Definition at line 131 of file RV_TextureRef.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 61 of file RV_TextureRef.h.

exint RV_TextureRef::id ( ) const

inline

Definition at line 83 of file RV_TextureRef.h.

bool RV_TextureRef::isDirty ( ) const

inline

Texture has been changed since last check.

Definition at line 42 of file RV_TextureRef.h.

bool RV_TextureRef::isLoading ( ) const

inline

Texture is currently loading in the background.

Definition at line 39 of file RV_TextureRef.h.

bool RV_TextureRef::isMissingTex ( ) const

inline

Texture couldn't be found or resolved.

Definition at line 36 of file RV_TextureRef.h.

bool RV_TextureRef::isPlaceholder ( ) const

inline

Texture is missing; a default color used instead.

Definition at line 33 of file RV_TextureRef.h.

bool RV_TextureRef::isUDIM ( ) const

inline

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

Definition at line 59 of file RV_TextureRef.h.

bool RV_TextureRef::isValid ( ) const

inline

Reference to a valid texture.

Definition at line 29 of file RV_TextureRef.h.

RV_TextureRef& RV_TextureRef::operator= ( const RV_TextureRef &  other )

inline

Definition at line 85 of file RV_TextureRef.h.

void RV_TextureRef::reset ( void  )

inline

Reset the reference to a null handle.

Definition at line 46 of file RV_TextureRef.h.

Friends And Related Function Documentation

friend class RV_TextureCache

friend

Definition at line 161 of file RV_TextureRef.h.

---

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

• RV/RV_TextureRef.h