HdStTextureIdentifier Class Reference

Class to identify a texture file or a texture within the texture file (e.g., a frame in a movie). More...

#include <textureIdentifier.h>

Public Types
using	ID = size_t

Public Member Functions
HDST_API	HdStTextureIdentifier (const TfToken &filePath, const VtValue &fallback=VtValue(), bool defaultToFallback=false)
	C'tor for files that can contain only one texture.
HDST_API	HdStTextureIdentifier (const TfToken &filePath, std::unique_ptr< const HdStSubtextureIdentifier > &&subtextureId, const VtValue &fallback=VtValue(), bool defaultToFallback=false)
	C'tor for files that can contain more than one texture (e.g., frames in a movie, grids in a VDB file).
HDST_API	HdStTextureIdentifier (const HdStTextureIdentifier &textureId)
HDST_API HdStTextureIdentifier &	operator= (HdStTextureIdentifier &&textureId)
HDST_API HdStTextureIdentifier &	operator= (const HdStTextureIdentifier &textureId)
const TfToken &	GetFilePath () const
	Get file path of texture file.
const VtValue &	GetFallback () const
	Get fallback value that's used if loading from _filePath fails.
bool	ShouldDefaultToFallback () const
	Get if reading from _filePath should be skipped.
const HdStSubtextureIdentifier *	GetSubtextureIdentifier () const
	Get additional information identifying a texture in a file that can contain more than one texture (e.g., a frame in a movie or a grid in a VDB file).
HDST_API bool	operator== (const HdStTextureIdentifier &other) const
HDST_API bool	operator!= (const HdStTextureIdentifier &other) const

Detailed Description

Class to identify a texture file or a texture within the texture file (e.g., a frame in a movie).

The class has value semantics and uses HdStSubtextureIdentifier in a polymorphic way.

Definition at line 31 of file textureIdentifier.h.

Member Typedef Documentation

ID

using ID = size_t

Definition at line 34 of file textureIdentifier.h.

Constructor & Destructor Documentation

HdStTextureIdentifier() [1/2]

HDST_API HdStTextureIdentifier ( const TfToken &  filePath, const VtValue &  fallback = VtValue(), bool  defaultToFallback = false  )

explicit

C'tor for files that can contain only one texture.

HdStTextureIdentifier() [2/2]

HDST_API HdStTextureIdentifier	(	const TfToken &	filePath,
		std::unique_ptr< const HdStSubtextureIdentifier > &&	subtextureId,
		const VtValue &	fallback = VtValue(),
		bool	defaultToFallback = false
	)

C'tor for files that can contain more than one texture (e.g., frames in a movie, grids in a VDB file).

Member Function Documentation

GetFallback()

const VtValue & GetFallback ( ) const

inline

Get fallback value that's used if loading from _filePath fails.

Definition at line 77 of file textureIdentifier.h.

GetFilePath()

const TfToken & GetFilePath ( ) const

inline

Get file path of texture file.

Definition at line 71 of file textureIdentifier.h.

GetSubtextureIdentifier()

const HdStSubtextureIdentifier * GetSubtextureIdentifier ( ) const

inline

Get additional information identifying a texture in a file that can contain more than one texture (e.g., a frame in a movie or a grid in a VDB file).

nullptr for files (e.g., png) that can contain only one texture.

Definition at line 93 of file textureIdentifier.h.

ShouldDefaultToFallback()

bool ShouldDefaultToFallback ( ) const

inline

Get if reading from _filePath should be skipped.

Definition at line 83 of file textureIdentifier.h.

---

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

• pxr/imaging/hdSt/textureIdentifier.h