DI-Guy SDK Documentation  13.6
Public Member Functions | Public Attributes | Private Attributes | List of all members
diguyOglUniformBufferUpdater Class Reference
DI-Guy Graphics API OpenGL sample implementation

This is an example implementation of a diguyUniformBufferUpdater it's responsible for translating api independent calls into OpenGL functionality. More...

#include <diguyOglUniformBuffer.h>

Inheritance diagram for diguyOglUniformBufferUpdater:
diguyUniformBufferUpdater

Public Member Functions

 diguyOglUniformBufferUpdater ()
 
virtual ~diguyOglUniformBufferUpdater ()
 
virtual void initialize () override
 
virtual void update () override
 called before any drawing calls. More...
 
virtual void set_model_matrix (const float *matrix) override
 Called as part of diguy scene traversing code. More...
 
virtual void set_view_matrix (const float *matrix) override
 Called as part of diguy camera apply function. More...
 
virtual void get_view_matrix (float *matrix, int transpose) override
 Needed by particle systems. More...
 
virtual void get_projection_matrix (float *matrix, int transpose) override
 helper function if neede More...
 
virtual void set_projection_matrix (const float *matrix) override
 Called as part of diguy camera apply function. More...
 
virtual void set_texture_matrix (const float *matrix) override
 Needed for shadow casting. More...
 
virtual void set_material (const diguyGraphicsMaterial *material) override
 This uniform material updater effectively replaces a subclassed graphics material in immediate mode, since that class just communicates old style OpenGL state values down to the shader. More...
 
virtual void set_material_color (float r, float g, float b, float a) override
 needed for drawing helper objects More...
 
virtual void set_material_spec (float r, float g, float b, float shine) override
 
virtual void set_fog (const diguyViewFog *fog) override
 indicates the current diguy fog to use for rendering. Probably only relevant to DI-Guy Scenario More...
 
virtual void set_global_ambient_light (float r, float g, float b) override
 Replacement for gl light model. More...
 
virtual void set_eye_position (float x, float y, float z) override
 
virtual void set_use_global_ambient_material (int val) override
 Indicates that when material bind happens the ambient value of the material should be ignored and the value from set_global_ambient_material() should be used. More...
 
virtual int get_use_global_ambient_material () override
 
virtual void set_global_ambient_material (float r, float g, float b) override
 
virtual void get_global_ambient_material (float **\return, float *g, float **< b >) override
 
</b > virtual void set_light (int index, const diguyLightRenderDesc *light) override
 See diguyOglUtils::update_lighting for an example of using this function to fill out uniform buffer. More...
 
virtual void set_num_active_lights (int num_lights) override
 Called so shaders know how many lights to iterate through. More...
 
virtual void set_shadow_map_params (const diguyShadowMapParams *shadow_params) override
 Used by DI-Guy Scenario to communicate shadow params to video card. More...
 
- Public Member Functions inherited from diguyUniformBufferUpdater
 diguyUniformBufferUpdater ()
 
virtual ~diguyUniformBufferUpdater ()
 

Public Attributes

diguyOglPerFrameUniformBuffer m_per_frame_ubo
 data that will change infrequently, lights, fog, shadows, etc More...
 
diguyOglTransformUniformBuffer m_transform_stack_ubo
 the equivalent of the OpenGL matrix stack More...
 
diguyOglMaterialUniformBuffer m_material_ubo
 the equivalent of the OpenGL material structures More...
 
GLhandleARB m_uniform_transform_buffer_object
 handles to Uniform buffers. More...
 
GLhandleARB m_uniform_material_buffer_object
 
GLhandleARB m_uniform_per_frame_buffer_object
 

Private Attributes

int m_per_frame_uniforms_needs_update
 
int m_transform_stack_needs_update
 
const diguyGraphicsMaterial * m_last_material
 
int m_use_global_ambient_material
 
glm::vec4 m_global_ambient_material
 

Detailed Description

This is an example implementation of a diguyUniformBufferUpdater it's responsible for translating api independent calls into OpenGL functionality.

With OpenGL 3.2 the fixed function pipeline is deprecated and the only way to communicate information to the video card is via uniforms. diguyOglUniformBufferUpdater is responsible for wrapping a number of uniform buffer objects that can be shared between shaders eliminating the need to resend the information for every shader.

Constructor & Destructor Documentation

diguyOglUniformBufferUpdater::diguyOglUniformBufferUpdater ( )
diguyOglUniformBufferUpdater::~diguyOglUniformBufferUpdater ( )
virtual

Member Function Documentation

void diguyOglUniformBufferUpdater::initialize ( )
overridevirtual

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::update ( )
overridevirtual

called before any drawing calls.

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::set_model_matrix ( const float *  matrix)
overridevirtual

Called as part of diguy scene traversing code.

Typically called once per character draw Potentially called many times for scene objects.

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::set_view_matrix ( const float *  matrix)
overridevirtual

Called as part of diguy camera apply function.

Presumably end users will want to call it themselves to setup the uniform buffer data.

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::get_view_matrix ( float *  matrix,
int  transpose 
)
overridevirtual

Needed by particle systems.

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::get_projection_matrix ( float *  matrix,
int  transpose 
)
overridevirtual

helper function if neede

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::set_projection_matrix ( const float *  matrix)
overridevirtual

Called as part of diguy camera apply function.

Presumably end users will want to call it themselves to setup the uniform buffer data.

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::set_texture_matrix ( const float *  matrix)
overridevirtual

Needed for shadow casting.

This matrix will only be used for projecting light coordinates Probably only relevant to DI-Guy Scenario and shadowing examples.

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::set_material ( const diguyGraphicsMaterial *  material)
overridevirtual

This uniform material updater effectively replaces a subclassed graphics material in immediate mode, since that class just communicates old style OpenGL state values down to the shader.

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::set_material_color ( float  r,
float  g,
float  b,
float  a 
)
overridevirtual

needed for drawing helper objects

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::set_material_spec ( float  r,
float  g,
float  b,
float  shine 
)
overridevirtual

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::set_fog ( const diguyViewFog *  fog)
overridevirtual

indicates the current diguy fog to use for rendering. Probably only relevant to DI-Guy Scenario

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::set_global_ambient_light ( float  r,
float  g,
float  b 
)
overridevirtual

Replacement for gl light model.

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::set_eye_position ( float  x,
float  y,
float  z 
)
overridevirtual

Implements diguyUniformBufferUpdater.

virtual void diguyOglUniformBufferUpdater::set_use_global_ambient_material ( int  val)
inlineoverridevirtual

Indicates that when material bind happens the ambient value of the material should be ignored and the value from set_global_ambient_material() should be used.

Implements diguyUniformBufferUpdater.

virtual int diguyOglUniformBufferUpdater::get_use_global_ambient_material ( )
inlineoverridevirtual

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::set_global_ambient_material ( float  r,
float  g,
float  b 
)
overridevirtual

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::get_global_ambient_material ( float **\  return,
float *  g,
float **< b >   
)
overridevirtual

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::set_light ( int  index,
const diguyLightRenderDesc *  light 
)
overridevirtual

See diguyOglUtils::update_lighting for an example of using this function to fill out uniform buffer.

Light sources can be diguy global directional light in addition to particle systems and weapon effects.

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::set_num_active_lights ( int  num_lights)
overridevirtual

Called so shaders know how many lights to iterate through.

Implements diguyUniformBufferUpdater.

void diguyOglUniformBufferUpdater::set_shadow_map_params ( const diguyShadowMapParams *  shadow_params)
overridevirtual

Used by DI-Guy Scenario to communicate shadow params to video card.

Implements diguyUniformBufferUpdater.

Member Data Documentation

diguyOglPerFrameUniformBuffer diguyOglUniformBufferUpdater::m_per_frame_ubo

data that will change infrequently, lights, fog, shadows, etc

diguyOglTransformUniformBuffer diguyOglUniformBufferUpdater::m_transform_stack_ubo

the equivalent of the OpenGL matrix stack

diguyOglMaterialUniformBuffer diguyOglUniformBufferUpdater::m_material_ubo

the equivalent of the OpenGL material structures

GLhandleARB diguyOglUniformBufferUpdater::m_uniform_transform_buffer_object

handles to Uniform buffers.

GLhandleARB diguyOglUniformBufferUpdater::m_uniform_material_buffer_object
GLhandleARB diguyOglUniformBufferUpdater::m_uniform_per_frame_buffer_object
int diguyOglUniformBufferUpdater::m_per_frame_uniforms_needs_update
private
int diguyOglUniformBufferUpdater::m_transform_stack_needs_update
private
const diguyGraphicsMaterial* diguyOglUniformBufferUpdater::m_last_material
private
int diguyOglUniformBufferUpdater::m_use_global_ambient_material
private
glm::vec4 diguyOglUniformBufferUpdater::m_global_ambient_material
private
The documentation for this class was generated from the following files: