Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Static Public Attributes | List of all members
om::graphics::materials::ShaderSource Class Reference

A class that contains the source code for a shader. More...

#include <omGraphicsShaderSource.h>

Public Member Functions

 ShaderSource ()
 Create a new shader source with an undefined shader type and no source code. More...
 
 ShaderSource (ShaderType newShaderType)
 Create a new shader source with the specified shader type and no source code. More...
 
 ShaderSource (ShaderType newShaderType, const ShaderSourceString &newSource, const ShaderLanguage &newLanguage)
 Create a new shader source with the specified shader type and source code. More...
 
const ShaderTypegetType () const
 Return an object describing the type of shader this source code describes. More...
 
void setType (const ShaderType &newType)
 Set an object describing the type of shader this source code describes. More...
 
const ShaderLanguagegetLanguage () const
 Return an object describing the language in which this shader's source code is written. More...
 
void setLanguage (const ShaderLanguage &newLanguage)
 Set an object describing the language in which this shader's source code is written. More...
 
const ShaderSourceStringgetSource () const
 Return a string containing the source code for this shader. More...
 
void setSource (const ShaderSourceString &newSource)
 Set a string containing the source code for this shader. More...
 

Static Public Attributes

static const ResourceType RESOURCE_TYPE
 The resource type for ShaderSource. More...
 

Detailed Description

A class that contains the source code for a shader.

In addition to a string specifying the source code for the shader, a ShaderSource object also contains a ShaderType object specifying the type of shader the source code describes.

Constructor & Destructor Documentation

om::graphics::materials::ShaderSource::ShaderSource ( )

Create a new shader source with an undefined shader type and no source code.

om::graphics::materials::ShaderSource::ShaderSource ( ShaderType  newShaderType)

Create a new shader source with the specified shader type and no source code.

om::graphics::materials::ShaderSource::ShaderSource ( ShaderType  newShaderType,
const ShaderSourceString newSource,
const ShaderLanguage newLanguage 
)

Create a new shader source with the specified shader type and source code.

Member Function Documentation

const ShaderType& om::graphics::materials::ShaderSource::getType ( ) const
inline

Return an object describing the type of shader this source code describes.

void om::graphics::materials::ShaderSource::setType ( const ShaderType newType)
inline

Set an object describing the type of shader this source code describes.

const ShaderLanguage& om::graphics::materials::ShaderSource::getLanguage ( ) const
inline

Return an object describing the language in which this shader's source code is written.

void om::graphics::materials::ShaderSource::setLanguage ( const ShaderLanguage newLanguage)
inline

Set an object describing the language in which this shader's source code is written.

const ShaderSourceString& om::graphics::materials::ShaderSource::getSource ( ) const
inline

Return a string containing the source code for this shader.

void om::graphics::materials::ShaderSource::setSource ( const ShaderSourceString newSource)

Set a string containing the source code for this shader.

Member Data Documentation

const ResourceType om::graphics::materials::ShaderSource::RESOURCE_TYPE
static

The resource type for ShaderSource.


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