Public API Reference

iShaderProgram Struct Reference

A helper for shaders that which to use the general plugins. More...

#include <csplugincommon/shader/shaderplugin.h>

Inheritance diagram for iShaderProgram:

List of all members.

Public Member Functions
virtual void	Activate ()=0
	Sets this program to be the one used when rendering.
virtual void	Deactivate ()=0
	Deactivate program so that it's not used in next rendering.
virtual void	SetupState (const csRenderMesh *mesh, const csShaderVarStack &stacks)=0
	Setup states needed for proper operation of the shaderprogram.
virtual void	ResetState ()=0
	Reset states to original.
virtual bool	Load (iDocumentNode *node)=0
	Loads from a document-node.
virtual bool	Load (const char *program, csArray< csShaderVarMapping > &mappings)=0
	Loads from raw text.
virtual bool	Compile (csArray< iShaderVariableContext * > &staticDomains)=0
	Compile a program.
virtual int	ResolveTextureBinding (const char *binding)=0
	When the destination of a texture binding wasn't recognized, the FP is asked whether it can provide a TU number for it.

---

Detailed Description

A helper for shaders that which to use the general plugins.

This is the main program plugin interface

Definition at line 40 of file shaderplugin.h.

---

Member Function Documentation

virtual void iShaderProgram::Activate (   )  [pure virtual]

Sets this program to be the one used when rendering.

virtual bool iShaderProgram::Compile (  csArray< iShaderVariableContext * > &  staticDomains  )  [pure virtual]

Compile a program.

virtual void iShaderProgram::Deactivate (   )  [pure virtual]

Deactivate program so that it's not used in next rendering.

virtual bool iShaderProgram::Load (  const char *  program, csArray< csShaderVarMapping > &  mappings )  [pure virtual]

Loads from raw text.

virtual bool iShaderProgram::Load (  iDocumentNode *  node  )  [pure virtual]

Loads from a document-node.

virtual void iShaderProgram::ResetState (   )  [pure virtual]

Reset states to original.

virtual int iShaderProgram::ResolveTextureBinding (  const char *  binding  )  [pure virtual]

When the destination of a texture binding wasn't recognized, the FP is asked whether it can provide a TU number for it.

virtual void iShaderProgram::SetupState (  const csRenderMesh *  mesh, const csShaderVarStack &  stacks )  [pure virtual]

Setup states needed for proper operation of the shaderprogram.

---

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

• csplugincommon/shader/shaderplugin.h

---