All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdStTextureIdentifier Class Referencefinal

#include <textureIdentifier.h>

Public Types

using ID = size_t

Public Member Functions

HDST_API HdStTextureIdentifier ()
HDST_API HdStTextureIdentifier (const TfToken &filePath)
HDST_API HdStTextureIdentifier (const TfToken &filePath, std::unique_ptr< const HdStSubtextureIdentifier > &&subtextureId)
HDST_API HdStTextureIdentifier (const HdStTextureIdentifier &textureId)
HDST_API HdStTextureIdentifieroperator= (HdStTextureIdentifier &&textureId)
HDST_API HdStTextureIdentifieroperator= (const HdStTextureIdentifier &textureId)
HDST_API ~HdStTextureIdentifier ()
const TfTokenGetFilePath () const
const HdStSubtextureIdentifierGetSubtextureIdentifier () const
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 47 of file textureIdentifier.h.

Member Typedef Documentation

using HdStTextureIdentifier::ID = size_t

Definition at line 50 of file textureIdentifier.h.

Constructor & Destructor Documentation

HDST_API HdStTextureIdentifier::HdStTextureIdentifier ( )
HDST_API HdStTextureIdentifier::HdStTextureIdentifier ( const TfToken filePath)

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

HDST_API HdStTextureIdentifier::HdStTextureIdentifier ( const TfToken filePath,
std::unique_ptr< const HdStSubtextureIdentifier > &&  subtextureId 

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::HdStTextureIdentifier ( const HdStTextureIdentifier textureId)
HDST_API HdStTextureIdentifier::~HdStTextureIdentifier ( )

Member Function Documentation

const TfToken& HdStTextureIdentifier::GetFilePath ( ) const

Get file path of texture file.

Definition at line 82 of file textureIdentifier.h.

const HdStSubtextureIdentifier* HdStTextureIdentifier::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).

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

Definition at line 92 of file textureIdentifier.h.

HDST_API HdStTextureIdentifier& HdStTextureIdentifier::operator= ( HdStTextureIdentifier &&  textureId)
HDST_API HdStTextureIdentifier& HdStTextureIdentifier::operator= ( const HdStTextureIdentifier textureId)
HDST_API bool HdStTextureIdentifier::operator== ( const HdStTextureIdentifier other) const

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