jpp::video::IShaderConstantSetCallBack Class Reference

Interface making it possible to set constants for gpu programs every frame. More...

#include <jimcpp/core/engine/IShaderConstantSetCallBack.hpp>

Inheritance diagram for jpp::video::IShaderConstantSetCallBack:

Collaboration diagram for jpp::video::IShaderConstantSetCallBack:

Public Member Functions
virtual void	OnSetMaterial (const SMaterial &material)
	Called to let the callBack know the used material (optional method)
virtual void	OnSetConstants (IMaterialRendererServices *services, s32 userData)=0
	Called by the engine when the vertex and/or pixel shader constants for an material renderer should be set.
Public Member Functions inherited from jpp::IReferenceCounted
	IReferenceCounted ()
	Constructor.
virtual	~IReferenceCounted ()
	Destructor.
void	grab () const
	Grabs the object. Increments the reference counter by one.
bool	drop () const
	Drops the object. Decrements the reference counter by one.
s32	getReferenceCount () const
	Get the reference count.
const c8 *	getDebugName () const
	Returns the debug name of the object.

Additional Inherited Members
Protected Member Functions inherited from jpp::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object.

Detailed Description

Interface making it possible to set constants for gpu programs every frame.

Implement this interface in an own class and pass a pointer to it to one of the methods in IGPUProgrammingServices when creating a shader. The OnSetConstants method will be called every frame now.

Member Function Documentation

OnSetConstants()

virtual void jpp::video::IShaderConstantSetCallBack::OnSetConstants ( IMaterialRendererServices *  services, s32  userData  )

pure virtual

Called by the engine when the vertex and/or pixel shader constants for an material renderer should be set.

Implement the IShaderConstantSetCallBack in an own class and implement your own OnSetConstants method using the given IMaterialRendererServices interface. Pass a pointer to this class to one of the methods in IGPUProgrammingServices when creating a shader. The OnSetConstants method will now be called every time before geometry is being drawn using your shader material. A sample implementation would look like this:

virtual void OnSetConstants(video::IMaterialRendererServices* services, s32 userData)
{
    video::IVideoDriver* driver = services->getVideoDriver();
 
    // set clip matrix at register 4
    core::matrix4 worldViewProj(driver->getTransform(video::ETS_PROJECTION));
    worldViewProj *= driver->getTransform(video::ETS_VIEW);
    worldViewProj *= driver->getTransform(video::ETS_WORLD);
    services->setVertexShaderConstant(&worldViewProj.M[0], 4, 4);
    // for high level shading languages, this would be another solution:
    //services->setVertexShaderConstant("mWorldViewProj", worldViewProj.M, 16);
 
    // set some light color at register 9
    video::SColorf col(0.0f,1.0f,1.0f,0.0f);
    services->setVertexShaderConstant(reinterpret_cast<const f32*>(&col), 9, 1);
    // for high level shading languages, this would be another solution:
    //services->setVertexShaderConstant("myColor", reinterpret_cast<f32*>(&col), 4);
}

Parameters

services	Pointer to an interface providing methods to set the constants for the shader.
userData	Userdata int which can be specified when creating the shader.

OnSetMaterial()

virtual void jpp::video::IShaderConstantSetCallBack::OnSetMaterial ( const SMaterial &  material )

inlinevirtual

Called to let the callBack know the used material (optional method)

class MyCallBack : public IShaderConstantSetCallBack
{
    const video::SMaterial *UsedMaterial;
 
    OnSetMaterial(const video::SMaterial& material)
    {
        UsedMaterial=&material;
    }
 
    OnSetConstants(IMaterialRendererServices* services, s32 userData)
    {
        services->setVertexShaderConstant("myColor", reinterpret_cast<f32*>(&UsedMaterial->color), 4);
    }
}

---

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

• include/jimcpp/core/engine/IShaderConstantSetCallBack.hpp