class ShaderGenerator ​

Given a material, the shader data class keeps the relevant shader data and is able to generate a GLSL/HLSL shader.

Properties ​

Methods ​

Static methods ​

Properties details ​

GenerateFullShader ​

The GenerateFullShader flag value. If set, the shader generator will generate a full shader, and not just the material shader tree. If false, the generator will define the basic samplers, the per-fragment information and all the sampling tree functions, but not the vertex and fragment shaders, that the user will have to generate manually. This is useful for custom shader integration.

// Setter
void SetGenerateFullShader( bool value ) const;

// Getter
bool GetGenerateFullShader() const;

// Setter
void SetGenerateFullShader(bool value);

// Getter
bool GetGenerateFullShader();

# Setter
None SetGenerateFullShader(value: bool)

# Getter
bool GetGenerateFullShader()

GenerateTextureSamplerData ​

The GenerateTextureSamplerData flag value. If set, the shader generator will generate sampler registers and uniforms (HLSL: map_[x] values, state_[x]). If not set, the user will need to define them manually. As a help, the code is still generated, but commented out. This flag only applies to when the shader only generates the shading sampling tree, and is ignored if the GenerateFullShader is set.

// Setter
void SetGenerateTextureSamplerData( bool value ) const;

// Getter
bool GetGenerateTextureSamplerData() const;

// Setter
void SetGenerateTextureSamplerData(bool value);

// Getter
bool GetGenerateTextureSamplerData();

# Setter
None SetGenerateTextureSamplerData(value: bool)

# Getter
bool GetGenerateTextureSamplerData()

IdentifersPrefix ​

The prefix for all global identifiers.

// Setter
void SetIdentifersPrefix( const char * value ) const;

// Getter
spString GetIdentifersPrefix() const;

// Setter
void SetIdentifersPrefix(string value);

// Getter
string GetIdentifersPrefix();

# Setter
None SetIdentifersPrefix(value: str)

# Getter
str GetIdentifersPrefix()

Material ​

The material, for which to create a shader.

// Setter
void SetMaterial( const spMaterial & value ) const;

// Getter
spMaterial GetMaterial() const;

// Setter
void SetMaterial(spMaterial value);

// Getter
spMaterial GetMaterial();

# Setter
None SetMaterial(value: spMaterial)

# Getter
spMaterial GetMaterial()

Name ​

The name of the ShaderGenerator object. (Inherited from Object)

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

// Setter
void SetName(string name);

// Getter
string GetName();

# Setter
None SetName(name: str)

# Getter
str GetName()

Methods details ​

AddObserver ​

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

rid AddObserver( const spObserver & observer ) const;

int AddObserver(spObserver observer);

int AddObserver(observer: spObserver)

GenerateShaderData ​

Generates a shader, given a material that uses shading node networks. To generate the actual shader code, use GetHLSLCode, GetGLSLVertexCode and GetGLSLFragmentCode.

bool GenerateShaderData() const;

bool GenerateShaderData();

bool GenerateShaderData()

GetClass ​

Get the name of the ShaderGenerator class. (Inherited from Object)

spString GetClass() const;

string GetClass();

str GetClass()

GetGLSLFragmentCode ​

Returns a string containing the GLSL fragment shader GenerateShader must have been called prior to this call.

spString GetGLSLFragmentCode() const;

string GetGLSLFragmentCode();

str GetGLSLFragmentCode()

GetGLSLVertexCode ​

Returns a string containing the GLSL vertex shader GenerateShader must have been called prior to this call. Note: If GenerateFullShader is set to false, this code will be empty, as the code generated is only used by the fragment shader.

spString GetGLSLVertexCode() const;

string GetGLSLVertexCode();

str GetGLSLVertexCode()

GetHLSLCode ​

Returns a string containing the HLSL shader code. GenerateShader must have been called prior to this call.

spString GetHLSLCode() const;

string GetHLSLCode();

str GetHLSLCode()

GetShaderInputTexturePath ​

Get a specific path from the list of unique paths. See notes of GetShaderInputTexturePathsCount for more documentation on usage.

spString GetShaderInputTexturePath( rid index ) const;

string GetShaderInputTexturePath(int index);

str GetShaderInputTexturePath(index: int)

GetShaderInputTexturePathsCount ​

The number of unique texture paths used in the material. For the shader to use these textures, they are required to be uploaded to the texture channel corresponding to their position in the array. The shader will generate these sampler variables with the naming convention "map_i" (i : the array index of the texture). GenerateShader must have been called prior to this call. Enumerate 0 to Count, and use GetShaderInputTexturePath to retrieve a specific path.

unsigned int GetShaderInputTexturePathsCount() const;

uint GetShaderInputTexturePathsCount();

int GetShaderInputTexturePathsCount()

GetShaderInputUVIndex ​

Returns the index that is set for the specific input UV set. If the UV set is not used by the generated shader, the returned value is -1. Note that the UV set name must match exactly, including case.

rid GetShaderInputUVIndex( const char * uvset ) const;

int GetShaderInputUVIndex(string uvset);

int GetShaderInputUVIndex(uvset: str)

GetShaderInputUVSet ​

Get a specific set from the list of unique sets. See notes of GetShaderInputUVSetsCount for more documentation on usage.

spString GetShaderInputUVSet( rid index ) const;

string GetShaderInputUVSet(int index);

str GetShaderInputUVSet(index: int)

GetShaderInputUVSetsCount ​

The number of unique UV sets used in the material. For the shader to use these UV sets, they are required to be uploaded as texture coordinates corresponding to their position in the array. The shader will generate the texcoords variables with the naming convention "tex_i" (i : the array index of the UV set). GenerateShader must have been called prior to this call.

unsigned int GetShaderInputUVSetsCount() const;

uint GetShaderInputUVSetsCount();

int GetShaderInputUVSetsCount()

GetShaderInputVertexColor ​

Get a specific set from the list of unique sets. See notes of GetShaderInputVertexColorsCount for more documentation on usage.

spString GetShaderInputVertexColor( rid index ) const;

string GetShaderInputVertexColor(int index);

str GetShaderInputVertexColor(index: int)

GetShaderInputVertexColorsCount ​

The number of unique vertex colors used in the material. For the shader to use these vertex colors, they are required to be uploaded as vertex color corresponding to their position in the array. The shader will generate the vertex color variables with the naming convention "vertexcolor_i" (i : the array index of the vertex color). GenerateShader must have been called prior to this call.

unsigned int GetShaderInputVertexColorsCount() const;

uint GetShaderInputVertexColorsCount();

int GetShaderInputVertexColorsCount()

GetShaderInputVertexColorsIndex ​

Returns the index that is set for the specific input vertex color set. If the vertex color set is not used by the generated shader, the returned value is -1. Note that the vertex color set name must match exactly, including case.

rid GetShaderInputVertexColorsIndex( const char * colorset ) const;

int GetShaderInputVertexColorsIndex(string colorset);

int GetShaderInputVertexColorsIndex(colorset: str)

IsA ​

Returns true if ShaderGenerator is a or is a descendant of the class named as the type parameter. (Inherited from Object)

bool IsA( const char * type ) const;

bool IsA(string type);

bool IsA(type: str)

IsNull ​

Returns true if the ShaderGenerator object is invalid. (Inherited from Object)

bool IsNull() const;

bool IsNull();

bool IsNull()

IsSameObjectAs ​

Returns true if the ShaderGenerator object is valid. (Inherited from Object)

bool IsSameObjectAs( const spObject & object ) const;

bool IsSameObjectAs(spObject object);

bool IsSameObjectAs(object: spObject)

NonNull ​

Returns true if the ShaderGenerator object is valid. (Inherited from Object)

bool NonNull() const;

bool NonNull();

bool NonNull()

PrintInfo ​

Prints the content/info of the ShaderGenerator object to the log. (Inherited from Object)

void PrintInfo() const;

void PrintInfo();

None PrintInfo()

RemoveObserver ​

Removes a previously added observer object. (Inherited from Object)

void RemoveObserver( rid observerId ) const;

void RemoveObserver(int observerId);

None RemoveObserver(observerId: int)

UnloadData ​

Unloads all shader data and resets it.

void UnloadData() const;

void UnloadData();

None UnloadData()

Static methods details ​

IsClassA ​

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

static bool IsClassA( const char * type ) const;

static bool IsClassA(string type);

@staticmethod
bool IsClassA(type: str)

SafeCast ​

SafeCast makes sure the input object is of a class that can be cast into spShaderGenerator, and if this is the case, returns the object cast into spShaderGenerator. (Inherited from Object)

static spShaderGenerator SafeCast( const spObject & object ) const;

static spShaderGenerator SafeCast(spObject object);

@staticmethod
spShaderGenerator SafeCast(object: spObject)