uicore::FrameBuffer Class Referenceabstract

Frame-buffer object class. More...

#include <frame_buffer.h>

Public Member Functions

virtual void attach_color (int attachment_index, const RenderBufferPtr &render_buffer)=0
 Attach color buffer. More...
 
virtual void attach_color (int attachment_index, const Texture1DPtr &texture, int level=0)=0
 
virtual void attach_color (int attachment_index, const Texture1DArrayPtr &texture, int array_index=-1, int level=0)=0
 
virtual void attach_color (int attachment_index, const Texture2DPtr &texture, int level=0)=0
 
virtual void attach_color (int attachment_index, const Texture2DArrayPtr &texture, int array_index=-1, int level=0)=0
 
virtual void attach_color (int attachment_index, const Texture3DPtr &texture, int depth, int level=0)=0
 
virtual void attach_color (int attachment_index, const TextureCubePtr &texture, TextureSubtype subtype, int level=0)=0
 
virtual void attach_depth (const RenderBufferPtr &render_buffer)=0
 Attach depth buffer. More...
 
virtual void attach_depth (const Texture2DPtr &texture, int level=0)=0
 
virtual void attach_depth (const TextureCubePtr &texture, TextureSubtype subtype, int level=0)=0
 
virtual void attach_depth_stencil (const RenderBufferPtr &render_buffer)=0
 
virtual void attach_depth_stencil (const Texture2DPtr &texture, int level=0)=0
 
virtual void attach_depth_stencil (const TextureCubePtr &texture, TextureSubtype subtype, int level=0)=0
 
virtual void attach_stencil (const RenderBufferPtr &render_buffer)=0
 Attach stencil buffer. More...
 
virtual void attach_stencil (const Texture2DPtr &texture, int level=0)=0
 
virtual void attach_stencil (const TextureCubePtr &texture, TextureSubtype subtype, int level=0)=0
 
virtual FrameBufferBindTarget bind_target () const =0
 Get the bind target of the framebuffer. More...
 
virtual void detach_color (int attachment_index)=0
 Detach color buffer. More...
 
virtual void detach_depth ()=0
 Detach depth buffer. More...
 
virtual void detach_depth_stencil ()=0
 
virtual void detach_stencil ()=0
 
virtual void set_bind_target (FrameBufferBindTarget target)=0
 Set the bind target of the framebuffer to either drawn to or read from. More...
 
virtual Size size () const =0
 Get the minumum size of all the frame buffer attachments. More...
 

Static Public Member Functions

static std::shared_ptr< FrameBuffercreate (const GraphicContextPtr &context)
 Constructs a FrameBuffer. More...
 

Detailed Description

Frame-buffer object class.

Member Function Documentation

virtual void uicore::FrameBuffer::attach_color ( int  attachment_index,
const RenderBufferPtr render_buffer 
)
pure virtual

Attach color buffer.

virtual void uicore::FrameBuffer::attach_color ( int  attachment_index,
const Texture1DPtr texture,
int  level = 0 
)
pure virtual
virtual void uicore::FrameBuffer::attach_color ( int  attachment_index,
const Texture1DArrayPtr texture,
int  array_index = -1,
int  level = 0 
)
pure virtual
virtual void uicore::FrameBuffer::attach_color ( int  attachment_index,
const Texture2DPtr texture,
int  level = 0 
)
pure virtual
virtual void uicore::FrameBuffer::attach_color ( int  attachment_index,
const Texture2DArrayPtr texture,
int  array_index = -1,
int  level = 0 
)
pure virtual
virtual void uicore::FrameBuffer::attach_color ( int  attachment_index,
const Texture3DPtr texture,
int  depth,
int  level = 0 
)
pure virtual
virtual void uicore::FrameBuffer::attach_color ( int  attachment_index,
const TextureCubePtr texture,
TextureSubtype  subtype,
int  level = 0 
)
pure virtual
virtual void uicore::FrameBuffer::attach_depth ( const RenderBufferPtr render_buffer)
pure virtual

Attach depth buffer.

virtual void uicore::FrameBuffer::attach_depth ( const Texture2DPtr texture,
int  level = 0 
)
pure virtual
virtual void uicore::FrameBuffer::attach_depth ( const TextureCubePtr texture,
TextureSubtype  subtype,
int  level = 0 
)
pure virtual
virtual void uicore::FrameBuffer::attach_depth_stencil ( const RenderBufferPtr render_buffer)
pure virtual
virtual void uicore::FrameBuffer::attach_depth_stencil ( const Texture2DPtr texture,
int  level = 0 
)
pure virtual
virtual void uicore::FrameBuffer::attach_depth_stencil ( const TextureCubePtr texture,
TextureSubtype  subtype,
int  level = 0 
)
pure virtual
virtual void uicore::FrameBuffer::attach_stencil ( const RenderBufferPtr render_buffer)
pure virtual

Attach stencil buffer.

virtual void uicore::FrameBuffer::attach_stencil ( const Texture2DPtr texture,
int  level = 0 
)
pure virtual
virtual void uicore::FrameBuffer::attach_stencil ( const TextureCubePtr texture,
TextureSubtype  subtype,
int  level = 0 
)
pure virtual
virtual FrameBufferBindTarget uicore::FrameBuffer::bind_target ( ) const
pure virtual

Get the bind target of the framebuffer.

Returns
The bind target
static std::shared_ptr<FrameBuffer> uicore::FrameBuffer::create ( const GraphicContextPtr context)
static

Constructs a FrameBuffer.

By default, the bind target is set to framebuffer_draw. See set_bind_target()

virtual void uicore::FrameBuffer::detach_color ( int  attachment_index)
pure virtual

Detach color buffer.

virtual void uicore::FrameBuffer::detach_depth ( )
pure virtual

Detach depth buffer.

virtual void uicore::FrameBuffer::detach_depth_stencil ( )
pure virtual
virtual void uicore::FrameBuffer::detach_stencil ( )
pure virtual
virtual void uicore::FrameBuffer::set_bind_target ( FrameBufferBindTarget  target)
pure virtual

Set the bind target of the framebuffer to either drawn to or read from.

Detach existing textures and renderbuffers before setting a new bind target

virtual Size uicore::FrameBuffer::size ( ) const
pure virtual

Get the minumum size of all the frame buffer attachments.


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