Castor3D::TextureAttachment Class Reference

Description of an attachment between a frame buffer and a texture. More...

Inheritance diagram for Castor3D::TextureAttachment:

Collaboration diagram for Castor3D::TextureAttachment:

Public Member Functions
C3D_API	TextureAttachment (DynamicTextureSPtr p_texture)
	Constructor. More...
virtual C3D_API	~TextureAttachment ()
	Destructor. More...
virtual C3D_API Castor::PxBufferBaseSPtr	GetBuffer () const
DynamicTextureSPtr	GetTexture () const
	Retrieves the texture. More...
eTEXTURE_TARGET	GetTarget () const
	Retrieves the attached target dimension. More...
int	GetLayer () const
	Retrieves the attached layer. More...
void	SetTarget (eTEXTURE_TARGET p_target)
	Retrieves the attached target dimension. More...
void	SetLayer (int p_layer)
	Sets the attached layer. More...
Public Member Functions inherited from Castor3D::FrameBufferAttachment
C3D_API Castor::PxBufferBaseSPtr	DownloadBuffer ()
	Downloads the render buffer data. More...
virtual C3D_API bool	Blit (FrameBufferSPtr p_buffer, Castor::Rectangle const &p_rectSrc, Castor::Rectangle const &p_rectDst, eINTERPOLATION_MODE p_interpolation)=0
	Blit this attachment's buffer into the given one. More...
eATTACHMENT_POINT	GetAttachmentPoint () const
eATTACHMENT_TYPE	GetAttachmentType () const
uint8_t	GetAttachmentIndex () const

Additional Inherited Members
Protected Member Functions inherited from Castor3D::FrameBufferAttachment
C3D_API	FrameBufferAttachment (eATTACHMENT_TYPE p_type)
	Constructor. More...
virtual C3D_API	~FrameBufferAttachment ()
	Destructor. More...
C3D_API bool	Attach (eATTACHMENT_POINT p_attachment, uint8_t p_index, FrameBufferSPtr p_frameBuffer)
	Attaches the render buffer to the given frame buffer, at given attachment point. More...
C3D_API bool	Attach (eATTACHMENT_POINT p_attachment, FrameBufferSPtr p_frameBuffer)
	Attaches the render buffer to the given frame buffer, at given attachment point. More...
C3D_API void	Detach ()
	Detaches the render buffer from the frame buffer. More...
virtual C3D_API bool	DoAttach (FrameBufferSPtr p_frameBuffer)=0
	Attaches the render buffer to the given frame buffer, at given attachment point. More...
virtual C3D_API void	DoDetach ()=0
	Detaches the render buffer from the frame buffer. More...
bool	HasFrameBuffer ()
FrameBufferSPtr	GetFrameBuffer ()

Detailed Description

Description of an attachment between a frame buffer and a texture.

Author

Sylvain DOREMUS

Version

0.7.0.0

Date

12/11/2012

Constructor & Destructor Documentation

TextureAttachment()

C3D_API Castor3D::TextureAttachment::TextureAttachment

(

DynamicTextureSPtr

p_texture

)

Constructor.

Parameters

[in]

p_texture

The texture

~TextureAttachment()

virtual C3D_API Castor3D::TextureAttachment::~TextureAttachment ( )

virtual

Destructor.

Member Function Documentation

GetBuffer()

virtual C3D_API Castor::PxBufferBaseSPtr Castor3D::TextureAttachment::GetBuffer ( ) const

virtual

Returns

The data buffer.

Implements Castor3D::FrameBufferAttachment.

GetLayer()

int Castor3D::TextureAttachment::GetLayer ( ) const

inline

Retrieves the attached layer.

Returns

The layer

GetTarget()

eTEXTURE_TARGET Castor3D::TextureAttachment::GetTarget ( ) const

inline

Retrieves the attached target dimension.

Returns

The target dimension

GetTexture()

DynamicTextureSPtr Castor3D::TextureAttachment::GetTexture ( ) const

inline

Retrieves the texture.

Returns

The texture

SetLayer()

void Castor3D::TextureAttachment::SetLayer ( int  p_layer )

inline

Sets the attached layer.

Parameters

[in]

p_layer

The layer.

SetTarget()

void Castor3D::TextureAttachment::SetTarget ( eTEXTURE_TARGET  p_target )

inline

Retrieves the attached target dimension.

Parameters

[in]

p_target

The target dimension.

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/TextureAttachment.hpp