#include <drawTarget.h>

Inheritance diagram for GlfDrawTarget::Attachment:

Public Types
typedef TfDeclarePtrs< class Attachment >::RefPtr	AttachmentRefPtr

Public Types inherited from GlfTexture
typedef std::vector< Binding >	BindingVector

Public Types inherited from TfRefBase
typedef void(*	UniqueChangedFuncPtr )(TfRefBase const *, bool)

Public Member Functions
GLF_API	~Attachment () override

GLuint	GetGlTextureName () override
	Returns the GL texture index (can be used as any regular GL texture) More...

GLuint	GetGlTextureMSName () const
	Returns the GL texture index multisampled of this attachment. More...

GLenum	GetFormat () const
	Returns the GL format of the texture (GL_RGB, GL_DEPTH_COMPONENT...) More...

GLenum	GetType () const
	Returns the GL type of the texture (GL_BYTE, GL_INT, GL_FLOAT...) More...

GLenum	GetInternalFormat () const
	Returns the GL internalFormat of the texture. More...

int	GetAttach () const
	Returns the GL attachment point index in the framebuffer. More...

GLF_API void	ResizeTexture (const GfVec2i &size)
	Resize the attachment recreating the texture. More...

GLF_API BindingVector	GetBindings (TfToken const &identifier, GLuint samplerName) override

GLF_API VtDictionary	GetTextureInfo (bool forceLoad) override

GLF_API void	TouchContents ()

Public Member Functions inherited from GlfTexture
virtual GLF_API	~GlfTexture ()=0

	GlfTexture (const GlfTexture &)=delete

GlfTexture &	operator= (const GlfTexture &)=delete

GLF_API size_t	GetMemoryUsed () const
	Amount of memory used to store the texture. More...

GLF_API size_t	GetMemoryRequested () const
	Amount of memory the user wishes to allocate to the texture. More...

GLF_API void	SetMemoryRequested (size_t targetMemory)
	Specify the amount of memory the user wishes to allocate to the texture. More...

virtual GLF_API bool	IsMinFilterSupported (GLenum filter)

virtual GLF_API bool	IsMagFilterSupported (GLenum filter)

GLF_API size_t	GetContentsID () const

GLF_API HioImage::ImageOriginLocation	GetOriginLocation () const

GLF_API bool	IsOriginLowerLeft () const

Public Member Functions inherited from TfRefBase
	TfRefBase ()

size_t	GetCurrentCount () const
	Return the current reference count of this object. More...

bool	IsUnique () const
	Return true if only one `TfRefPtr` points to this object. More...

const TfRefCount &	GetRefCount () const

void	SetShouldInvokeUniqueChangedListener (bool shouldCall)

Public Member Functions inherited from TfWeakBase
	TfWeakBase ()

	TfWeakBase (const TfWeakBase &)

const TfWeakBase &	__GetTfWeakBase__ () const

const TfWeakBase &	operator= (const TfWeakBase &)

void	EnableNotification2 () const

TF_API void const *	GetUniqueIdentifier () const

Static Public Member Functions
static GLF_API AttachmentRefPtr	New (int glIndex, GLenum format, GLenum type, GLenum internalFormat, GfVec2i size, unsigned int numSamples)

Static Public Member Functions inherited from GlfTexture
static GLF_API size_t	GetTextureMemoryAllocated ()
	static reporting function More...

Static Public Member Functions inherited from TfRefBase
static TF_API void	SetUniqueChangedListener (UniqueChangedListener listener)

Additional Inherited Members
Protected Member Functions inherited from GlfTexture
GLF_API	GlfTexture ()

GLF_API	GlfTexture (HioImage::ImageOriginLocation originLocation)

GLF_API void	_SetMemoryUsed (size_t size)

virtual GLF_API void	_OnMemoryRequestedDirty ()

GLF_API void	_UpdateContentsID ()

Protected Member Functions inherited from TfRefBase
virtual TF_API	~TfRefBase ()

Protected Member Functions inherited from TfWeakBase
	~TfWeakBase ()

TfRefPtr< Tf_Remnant >	_Register () const

template<class T >
TfRefPtr< Tf_Remnant >	_Register (T *tempRmnt) const

bool	_HasRemnant () const

Detailed Description

Definition at line 89 of file drawTarget.h.

Member Typedef Documentation

typedef TfDeclarePtrs<class Attachment>::RefPtr GlfDrawTarget::Attachment::AttachmentRefPtr

Definition at line 91 of file drawTarget.h.

Constructor & Destructor Documentation

GLF_API GlfDrawTarget::Attachment::~Attachment ( )

override

Member Function Documentation

int GlfDrawTarget::Attachment::GetAttach ( ) const

inline

Returns the GL attachment point index in the framebuffer.

Definition at line 117 of file drawTarget.h.

GLF_API BindingVector GlfDrawTarget::Attachment::GetBindings	(	TfToken const &	identifier,
		GLuint	samplerId
	)

overridevirtual

Returns the bindings to use this texture for the shader resource named identifier. If samplerId is specified, the bindings returned will use this samplerId for resources which can be sampled.

Implements GlfTexture.

GLenum GlfDrawTarget::Attachment::GetFormat ( ) const

inline

Returns the GL format of the texture (GL_RGB, GL_DEPTH_COMPONENT...)

Definition at line 108 of file drawTarget.h.

GLuint GlfDrawTarget::Attachment::GetGlTextureMSName ( ) const

inline

Returns the GL texture index multisampled of this attachment.

Definition at line 105 of file drawTarget.h.

GLuint GlfDrawTarget::Attachment::GetGlTextureName ( )

overridevirtual

Returns the GL texture index (can be used as any regular GL texture)

Implements GlfTexture.

GLenum GlfDrawTarget::Attachment::GetInternalFormat ( ) const

inline

Returns the GL internalFormat of the texture.

Definition at line 114 of file drawTarget.h.

GLF_API VtDictionary GlfDrawTarget::Attachment::GetTextureInfo ( bool forceLoad )

overridevirtual

Implements GlfTexture.

GLenum GlfDrawTarget::Attachment::GetType ( ) const

inline

Returns the GL type of the texture (GL_BYTE, GL_INT, GL_FLOAT...)

Definition at line 111 of file drawTarget.h.

static GLF_API AttachmentRefPtr GlfDrawTarget::Attachment::New	(	int	glIndex,
		GLenum	format,
		GLenum	type,
		GLenum	internalFormat,
		GfVec2i	size,
		unsigned int	numSamples
	)

static

GLF_API void GlfDrawTarget::Attachment::ResizeTexture ( const GfVec2i & size )

Resize the attachment recreating the texture.

GLF_API void GlfDrawTarget::Attachment::TouchContents ( )

Updates the contents signature for the underlying texture to allow downstream consumers to know that the texture image data may have changed.

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

pxr/imaging/glf/drawTarget.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation