DI-Guy SDK Documentation  13.6
Public Member Functions | List of all members
diguyGraphicsFrameBuffer Class Referenceabstract
DI-Guy Graphics API

A class that represents a frame buffer, this is used by the graphics api to enable shadow maps in programming examples. Will probably be unnecessary for most customers. See diguyOglGraphicsFrameBuffer for a sample implementation. More...

#include <diguyGraphicsFrameBuffer.h>

Inheritance diagram for diguyGraphicsFrameBuffer:
diguyOglGraphicsFrameBuffer

Public Member Functions

 diguyGraphicsFrameBuffer ()
 
virtual ~diguyGraphicsFrameBuffer ()
 
virtual int resize (int width, int height)
 
virtual void set_shadow_map (int shadow_map)
 
virtual void set_enable_mipmaps (int enable_mipmaps)
 
virtual void set_texture_unit (int texture_unit)
 
int get_width ()
 
int get_height ()
 

Virtual Functions

The functions in this section are all virtual functions that will be called by DI-Guy at various times during DI-Guy execution.

They will need Graphics API specific functionality implemented.

Because the functions are all virtual, DI-Guy programmers can create a subclass of this class and override them. Unless otherwise stated, the base class functions do not need to be called.

int m_width
 
int m_height
 
int m_shadow_map
 
int m_enable_mipmaps
 
int m_texture_unit
 
virtual void bind ()=0
 binds the frame buffer More...
 
virtual void clear ()=0
 clears the frame buffer More...
 
virtual void unbind ()=0
 unbinds the frame buffer, presumably restores the main view rendering More...
 
unsigned virtual int get_texture_id ()=0
 
unsigned virtual int get_frame_buffer_id ()=0
 
unsigned virtual int get_depth_texture_id ()=0
 

Detailed Description

A class that represents a frame buffer, this is used by the graphics api to enable shadow maps in programming examples. Will probably be unnecessary for most customers. See diguyOglGraphicsFrameBuffer for a sample implementation.

Link against: libdiguy_graphics_api

Can be subclassed by filling out the diguy_graphics_set_frame_buffer_create_func().

Constructor & Destructor Documentation

diguyGraphicsFrameBuffer::diguyGraphicsFrameBuffer ( )
inline
virtual diguyGraphicsFrameBuffer::~diguyGraphicsFrameBuffer ( )
inlinevirtual

Member Function Documentation

virtual int diguyGraphicsFrameBuffer::resize ( int  width,
int  height 
)
inlinevirtual

Reimplemented in diguyOglGraphicsFrameBuffer.

virtual void diguyGraphicsFrameBuffer::set_shadow_map ( int  shadow_map)
inlinevirtual
virtual void diguyGraphicsFrameBuffer::set_enable_mipmaps ( int  enable_mipmaps)
inlinevirtual
virtual void diguyGraphicsFrameBuffer::set_texture_unit ( int  texture_unit)
inlinevirtual
int diguyGraphicsFrameBuffer::get_width ( )
inline
int diguyGraphicsFrameBuffer::get_height ( )
inline
virtual void diguyGraphicsFrameBuffer::bind ( )
pure virtual

binds the frame buffer

Implemented in diguyOglGraphicsFrameBuffer.

virtual void diguyGraphicsFrameBuffer::clear ( )
pure virtual

clears the frame buffer

Implemented in diguyOglGraphicsFrameBuffer.

virtual void diguyGraphicsFrameBuffer::unbind ( )
pure virtual

unbinds the frame buffer, presumably restores the main view rendering

Implemented in diguyOglGraphicsFrameBuffer.

unsigned virtual int diguyGraphicsFrameBuffer::get_texture_id ( )
pure virtual

Implemented in diguyOglGraphicsFrameBuffer.

unsigned virtual int diguyGraphicsFrameBuffer::get_frame_buffer_id ( )
pure virtual

Implemented in diguyOglGraphicsFrameBuffer.

unsigned virtual int diguyGraphicsFrameBuffer::get_depth_texture_id ( )
pure virtual

Implemented in diguyOglGraphicsFrameBuffer.

Member Data Documentation

int diguyGraphicsFrameBuffer::m_width
protected
int diguyGraphicsFrameBuffer::m_height
protected
int diguyGraphicsFrameBuffer::m_shadow_map
protected
int diguyGraphicsFrameBuffer::m_enable_mipmaps
protected
int diguyGraphicsFrameBuffer::m_texture_unit
protected
The documentation for this class was generated from the following file: