Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | List of all members
vl::GLSLFragmentShader Class Reference

Wraps a GLSL fragment shader to be bound to a GLSLProgram: the shader this shader will run on the programmable fragment processor. More...

#include <GLSL.hpp>

+ Inheritance diagram for vl::GLSLFragmentShader:

Public Member Functions

 GLSLFragmentShader (const String &source=String())
 
- Public Member Functions inherited from vl::GLSLShader
 GLSLShader ()
 
 GLSLShader (EShaderType type, const String &source_or_path)
 
 ~GLSLShader ()
 
void setType (EShaderType type)
 
EShaderType type () const
 
void setSource (const String &source_or_path)
 Sets the sources for this shader and schedules a recompilation for it. If the string passed is a file path the source is loaded from it. More...
 
const std::string & source () const
 Returns the sources for this shader. More...
 
void setPath (const String &path)
 The path from which the shader was loaded. More...
 
const Stringpath () const
 The path from which the shader was loaded. More...
 
bool reload ()
 Reloads the shader source and recompiles it. Returns true on success. More...
 
std::string getShaderSource () const
 Retrieves the shader source using glGetShaderSource() More...
 
bool compile ()
 Compiles the shader, see also http://www.opengl.org/sdk/docs/man/xhtml/glCompileShader.xml for more information. More...
 
bool compileStatus () const
 Returns true if the shader has been succesfully compiled. More...
 
String infoLog () const
 Returns a String object containing this shader's info log as returned by glGetShaderInfoLog(), see also http://www.opengl.org/sdk/docs/man/xhtml/glGetShaderInfoLog.xml for more information. More...
 
void createShader ()
 Creates the shader using the OpenGL function glCreateShader(), see also http://www.opengl.org/sdk/docs/man/xhtml/glCreateShader.xml for more information. More...
 
void deleteShader ()
 Deletes the shader using the OpenGL function glDeleteShader(), see also http://www.opengl.org/sdk/docs/man/xhtml/glDeleteShader.xml for more information. More...
 
unsigned int handle () const
 The handle of this OpenGL shader object as returned by glCreateShader() More...
 
- Public Member Functions inherited from vl::Object
 Object ()
 Constructor. More...
 
 Object (const Object &other)
 Copy constructor: copies the name, ref count mutex and user data. More...
 
Objectoperator= (const Object &other)
 Copy operator: copies the object's name, ref count mutex and user data. More...
 
const std::string & objectName () const
 The name of the object, by default set to the object's class name. More...
 
void setObjectName (const char *name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setObjectName (const std::string &name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setRefCountMutex (IMutex *mutex)
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () const
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
int referenceCount () const
 Returns the number of references of an object. More...
 
void incReference () const
 Increments the reference count of an object. More...
 
void decReference ()
 Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
 
void setAutomaticDelete (bool autodel_on)
 If set to true the Object is deleted when its reference count reaches 0. More...
 
bool automaticDelete () const
 If set to true the Object is deleted when its reference count reaches 0. More...
 
template<class T >
T * as ()
 Casts an Object to the specified class. More...
 
template<class T >
const T * as () const
 Casts an Object to the specified class. More...
 

Additional Inherited Members

- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 
- Protected Attributes inherited from vl::GLSLShader
EShaderType mType
 
std::string mSource
 
String mPath
 
unsigned int mHandle
 
bool mCompiled
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Detailed Description

Wraps a GLSL fragment shader to be bound to a GLSLProgram: the shader this shader will run on the programmable fragment processor.

See also
GLSLVertexShader, GLSLGeometryShader, GLSLTessControlShader, GLSLTessEvaluationShader, GLSLProgram, Effect

Definition at line 136 of file GLSL.hpp.

Constructor & Destructor Documentation

◆ GLSLFragmentShader()

vl::GLSLFragmentShader::GLSLFragmentShader ( const String source = String())
inline
Parameters
sourceFragment shader's source code or path to a text file containing the fragment shader's source code.

Definition at line 142 of file GLSL.hpp.


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