H3D API  2.4.1
Classes | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
H3D::ProgramShader Class Reference

he ProgramShader node defines a shader that can consist of one or more individually programmable, self contained pieces. More...

#include <H3D/ProgramShader.h>

Inheritance diagram for H3D::ProgramShader:
Inheritance graph

Classes

class  MFShaderProgram
 The MFShaderProgram class sets the profile for each ShaderProgram node that is added to it. More...
 

Public Member Functions

 ProgramShader (Inst< DisplayList > _displayList=0, Inst< SFNode > _metadata=0, Inst< SFBool > _isSelected=0, Inst< SFBool > _isValid=0, Inst< SFBool > _activate=0, Inst< SFString > _language=0, Inst< MFShaderProgram > _programs=0)
 Constructor.
 
virtual bool isSupported ()
 Returns true if the shader node type is supported by the browser.
 
virtual void render ()
 Sets up the shaders program and sets uniform variable values.
 
virtual void preRender ()
 Enables the shader programs.
 
virtual void postRender ()
 Disables the shader programs.
 
- Public Member Functions inherited from H3D::X3DShaderNode
 X3DShaderNode (Inst< DisplayList > _displayList=0, Inst< SFNode > _metadata=0, Inst< SFBool > _isSelected=0, Inst< SFBool > _isValid=0, Inst< SFBool > _activate=0, Inst< SFString > _language=0)
 Constructor.
 
void setSelected (bool selected)
 Set the isSelected field.
 
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value. More...
 
virtual bool isTransparent (X3DMaterialNode *)
 Returns a hint if the X3DShaderNode produces an alpha channel that is < 1, i.e. More...
 
- Public Member Functions inherited from H3D::X3DAppearanceChildNode
 X3DAppearanceChildNode (Inst< DisplayList > _displayList=0, Inst< SFNode > _metadata=0)
 Constructor.
 
virtual GLbitfield getAffectedGLAttribs ()
 Returns a bitmask of the OpenGL attrib bits that will be affected by this node. More...
 
- Public Member Functions inherited from H3D::X3DNode
 X3DNode (Inst< SFNode > _metadata=0)
 Constructor.
 
X3DMetadataObjectgetMetadataByName (const string &_name)
 Given a name, the first X3DMetadataObject in the metadata field that matches that name is returned. More...
 
- Public Member Functions inherited from H3D::Node
 Node ()
 Constructor.
 
virtual Nodeclone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL)
 Returns a new instance of this node type with the same state as this one. More...
 
virtual ~Node ()
 Destructor.
 
X3DPrototypeInstancegetProtoInstanceParent ()
 If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More...
 
void setProtoInstanceParent (X3DPrototypeInstance *p)
 Set the X3DPrototypeInstance this node is the the root node if applicaple.
 
virtual void traverseSG (TraverseInfo &ti)
 traverseSG is called once per scenegraph loop on the scene in order to traverse the scenegraph. More...
 
virtual bool lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result)
 Detect intersection between a line segment and the Node. More...
 
virtual void closestPoint (const Vec3f &p, NodeIntersectResult &result)
 Find closest point on Node to p. More...
 
virtual bool movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result)
 Detect collision between a moving sphere and the Node. More...
 
virtual FieldgetField (const string &_name) const
 return a pointer to the field specified by name within this instance
 
int addDestructCallback (void(*func)(Node *, void *), void *args)
 Add a callback function to be run on destruction of node. More...
 
int removeDestructCallback (void(*func)(Node *, void *), void *args)
 Add a callback function to be run on destruction of node. More...
 
- Public Member Functions inherited from H3D::H3DDisplayListObject
 H3DDisplayListObject (Inst< DisplayList > _displayList=0)
 Constructor.
 

Public Attributes

H3DUniquePtr< MFShaderProgramprograms
 The shader programs to use in the ProgramShader. More...
 
- Public Attributes inherited from H3D::X3DShaderNode
H3DUniquePtr< SFBoolisSelected
 The isSelected output field is used to indicate that this shader instance is the one selected for use by the browser. More...
 
H3DUniquePtr< SFBoolisValid
 The isValid field is used to indicate whether the current shader objects can be run as a shader program. More...
 
H3DUniquePtr< SFBoolactivate
 The activate field forces the shader to activate the contained objects. More...
 
H3DUniquePtr< EventCollectingField< Field > > activateMonitor
 field used to monitor if activate field is modified
 
H3DUniquePtr< SFStringlanguage
 The language field is used to indicate to the browser which shading language is used for the source file(s). More...
 
- Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNodemetadata
 Meta data about the node. More...
 
- Public Attributes inherited from H3D::H3DDisplayListObject
H3DUniquePtr< DisplayListdisplayList
 The DisplayList instance handling the OpenGL caching of this object.
 

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 
- Static Public Attributes inherited from H3D::X3DShaderNode
static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 
- Static Public Attributes inherited from H3D::X3DNode
static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 

Additional Inherited Members

- Public Types inherited from H3D::Node
typedef std::map< Node *, Node * > DeepCopyMap
 A map type used during a deep copy clone() to map from original nodes to cloned nodes.
 
- Static Public Member Functions inherited from H3D::X3DShaderNode
static X3DShaderNodegetActiveShader ()
 Gets the currently active shader, i.e. More...
 
- Static Public Member Functions inherited from H3D::Node
static unsigned int nrNodesAlive ()
 Returns the nr of nodes currently alive, i.e. nodes created but not destructed.
 
static int nrNodesCreated ()
 Returns the number of nodes created in total since the start of the program.
 
- Protected Member Functions inherited from H3D::Node
void cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for the clone() method. More...
 
- Static Protected Member Functions inherited from H3D::Node
static NodegetClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for nodes that implement clone() More...
 

Detailed Description

he ProgramShader node defines a shader that can consist of one or more individually programmable, self contained pieces.

Each piece, represented by a ShaderProgram node, shall be a self-contained source that does not rely on any other source file and can manage one part of the programmable pipeline (e.g., vertex or fragment processing).

This node can be used with the CG shading language in H3D API. You can also use the PackagedShader node with CG. If you want to use GLSL you will have to use the ComposedShader node.

The programs field consists of zero or more ShaderProgram node instances. In general, only two ShaderProgram instances will be needed: one each for vertex and fragment processing. Each shader language annex shall refine the required behaviour for processing this field.

The isValid field may add an additional semantic to indicate whether all parts are available.

Internal routes:

Examples:

Member Data Documentation

◆ programs

H3DUniquePtr< MFShaderProgram > H3D::ProgramShader::programs

The shader programs to use in the ProgramShader.

Access type: outputOnly

Referenced by postRender(), preRender(), ProgramShader(), and render().


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