Castor3D  ..
Public Member Functions | List of all members
Castor3D::RenderBufferAttachment Class Reference

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

+ Inheritance diagram for Castor3D::RenderBufferAttachment:
+ Collaboration diagram for Castor3D::RenderBufferAttachment:

Public Member Functions

C3D_API RenderBufferAttachment (RenderBufferSPtr p_renderBuffer)
 Constructor. More...
 
virtual C3D_API ~RenderBufferAttachment ()
 Destructor. More...
 
virtual C3D_API Castor::PxBufferBaseSPtr GetBuffer () const
 
RenderBufferSPtr GetRenderBuffer () const
 Retrieves the render buffer. 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 render buffer.

Author
Sylvain DOREMUS
Version
0.7.0.0
Date
12/11/2012

Constructor & Destructor Documentation

◆ RenderBufferAttachment()

C3D_API Castor3D::RenderBufferAttachment::RenderBufferAttachment ( RenderBufferSPtr  p_renderBuffer)

Constructor.

Parameters
[in]p_renderBufferThe render buffer

◆ ~RenderBufferAttachment()

virtual C3D_API Castor3D::RenderBufferAttachment::~RenderBufferAttachment ( )
virtual

Destructor.

Member Function Documentation

◆ GetBuffer()

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

Returns
The data buffer.

Implements Castor3D::FrameBufferAttachment.

◆ GetRenderBuffer()

RenderBufferSPtr Castor3D::RenderBufferAttachment::GetRenderBuffer ( ) const
inline

Retrieves the render buffer.

Returns
The render buffer

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