StdMeshMaterialPass Class Reference

#include <StdMeshMaterial.h>

Collaboration diagram for StdMeshMaterialPass:

Classes
class	ProgramInstance
struct	ShaderInstance

Public Types
enum	CullHardwareType { CH_Clockwise , CH_CounterClockwise , CH_None }
enum	SceneBlendType {   SB_One , SB_Zero , SB_DestColor , SB_SrcColor ,   SB_OneMinusDestColor , SB_OneMinusSrcColor , SB_DestAlpha , SB_SrcAlpha ,   SB_OneMinusDestAlpha , SB_OneMinusSrcAlpha }
enum	DepthFunctionType {   DF_AlwaysFail , DF_AlwaysPass , DF_Less , DF_LessEqual ,   DF_Equal , DF_NotEqual , DF_GreaterEqual , DF_Greater }

Public Member Functions
	StdMeshMaterialPass ()
void	Load (StdMeshMaterialParserCtx &ctx)
bool	IsOpaque () const

Public Attributes
StdCopyStrBuf	Name
std::vector< StdMeshMaterialTextureUnit >	TextureUnits
float	Ambient [4]
float	Diffuse [4]
float	Specular [4]
float	Emissive [4]
float	Shininess
bool	DepthCheck {true}
bool	DepthWrite {true}
CullHardwareType	CullHardware {CH_Clockwise}
SceneBlendType	SceneBlendFactors [2]
DepthFunctionType	AlphaRejectionFunction
float	AlphaRejectionValue
bool	AlphaToCoverage
ShaderInstance	FragmentShader
ShaderInstance	VertexShader
ShaderInstance	GeometryShader
std::shared_ptr< ProgramInstance >	Program

Detailed Description

Definition at line 370 of file StdMeshMaterial.h.

---

Class Documentation

StdMeshMaterialPass::ShaderInstance

struct StdMeshMaterialPass::ShaderInstance

Definition at line 429 of file StdMeshMaterial.h.

Collaboration diagram for StdMeshMaterialPass::ShaderInstance:

Class Members
StdMeshMaterialShaderParameters	Parameters
const StdMeshMaterialShader *	Shader

Member Enumeration Documentation

CullHardwareType

enum StdMeshMaterialPass::CullHardwareType

Enumerator
CH_Clockwise
CH_CounterClockwise
CH_None

Definition at line 373 of file StdMeshMaterial.h.

    {
        CH_Clockwise,
        CH_CounterClockwise,
        CH_None
    };

DepthFunctionType

enum StdMeshMaterialPass::DepthFunctionType

Enumerator
DF_AlwaysFail
DF_AlwaysPass
DF_Less
DF_LessEqual
DF_Equal
DF_NotEqual
DF_GreaterEqual
DF_Greater

Definition at line 394 of file StdMeshMaterial.h.

    {
        DF_AlwaysFail,
        DF_AlwaysPass,
        DF_Less,
        DF_LessEqual,
        DF_Equal,
        DF_NotEqual,
        DF_GreaterEqual,
        DF_Greater
    };

SceneBlendType

enum StdMeshMaterialPass::SceneBlendType

Enumerator
SB_One
SB_Zero
SB_DestColor
SB_SrcColor
SB_OneMinusDestColor
SB_OneMinusSrcColor
SB_DestAlpha
SB_SrcAlpha
SB_OneMinusDestAlpha
SB_OneMinusSrcAlpha

Definition at line 380 of file StdMeshMaterial.h.

    {
        SB_One,
        SB_Zero,
        SB_DestColor,
        SB_SrcColor,
        SB_OneMinusDestColor,
        SB_OneMinusSrcColor,
        SB_DestAlpha,
        SB_SrcAlpha,
        SB_OneMinusDestAlpha,
        SB_OneMinusSrcAlpha
    };

Constructor & Destructor Documentation

StdMeshMaterialPass()

StdMeshMaterialPass::StdMeshMaterialPass

(

)

Definition at line 1225 of file StdMeshMaterial.cpp.

{
    Ambient[0]  = Ambient[1]  = Ambient[2]  = 1.0f; Ambient[3]  = 1.0f;
    Diffuse[0]  = Diffuse[1]  = Diffuse[2]  = 1.0f; Diffuse[3]  = 1.0f;
    Specular[0] = Specular[1] = Specular[2] = 0.0f; Specular[3] = 0.0f;
    Emissive[0] = Emissive[1] = Emissive[2] = 0.0f; Emissive[3] = 0.0f;
    Shininess = 0.0f;
    SceneBlendFactors[0] = SB_One; SceneBlendFactors[1] = SB_Zero;
    AlphaRejectionFunction = DF_AlwaysPass; AlphaRejectionValue = 0.0f;
    AlphaToCoverage = false;
    VertexShader.Shader = FragmentShader.Shader = GeometryShader.Shader = nullptr;
}

References AlphaRejectionFunction, AlphaRejectionValue, AlphaToCoverage, Ambient, DF_AlwaysPass, Diffuse, Emissive, FragmentShader, GeometryShader, SB_One, SB_Zero, SceneBlendFactors, StdMeshMaterialPass::ShaderInstance::Shader, Shininess, Specular, and VertexShader.

Member Function Documentation

IsOpaque()

bool StdMeshMaterialPass::IsOpaque ( ) const

inline

Definition at line 409 of file StdMeshMaterial.h.

{ return SceneBlendFactors[1] == SB_Zero; }

References SB_Zero, and SceneBlendFactors.

Load()

void StdMeshMaterialPass::Load

(

StdMeshMaterialParserCtx &

ctx

)

Definition at line 1278 of file StdMeshMaterial.cpp.

{
    Token token;
    StdCopyStrBuf token_name;
    StdMeshMaterialSubLoader texture_unit_loader;
    while ((token = ctx.AdvanceNonEOF(token_name)) == TOKEN_IDTF)
    {
        if (token_name == "texture_unit")
        {
            texture_unit_loader.Load(ctx, TextureUnits);
        }
        else if (token_name == "ambient")
        {
            ctx.AdvanceColor(true, Ambient);
        }
        else if (token_name == "diffuse")
        {
            ctx.AdvanceColor(true, Diffuse);
        }
        else if (token_name == "specular")
        {
            Specular[0] = ctx.AdvanceFloat();
            Specular[1] = ctx.AdvanceFloat();
            Specular[2] = ctx.AdvanceFloat();
 
            // The fourth argument is optional, not the fifth:
            float specular3 = ctx.AdvanceFloat();
 
            float shininess;
            if (ctx.AdvanceFloatOptional(shininess))
            {
                Specular[3] = specular3;
                Shininess = shininess;
            }
            else
            {
                Shininess = specular3;
            }
        }
        else if (token_name == "emissive")
        {
            ctx.AdvanceColor(true, Emissive);
        }
        else if (token_name == "depth_check")
        {
            DepthCheck = ctx.AdvanceBoolean();
        }
        else if (token_name == "depth_write")
        {
            DepthWrite = ctx.AdvanceBoolean();
        }
        else if (token_name == "cull_hardware")
        {
            CullHardware = ctx.AdvanceEnum(CullHardwareEnumerators);
        }
        else if (token_name == "scene_blend")
        {
            ctx.AdvanceEnums<2, StdMeshMaterialPass::SceneBlendType>(SceneBlendEnumerators, SceneBlendShortcuts, SceneBlendFactors);
        }
        else if (token_name == "scene_blend_op")
        {
            StdStrBuf op;
            ctx.AdvanceRequired(op, TOKEN_IDTF);
            ctx.WarningNotSupported(token_name.getData());
        }
        else if (token_name == "alpha_rejection")
        {
            AlphaRejectionFunction = ctx.AdvanceEnum(DepthFunctionEnumerators);
            if (AlphaRejectionFunction != DF_AlwaysFail && AlphaRejectionFunction != DF_AlwaysPass)
                AlphaRejectionValue = ctx.AdvanceFloat() / 255.0f;
        }
        else if (token_name == "alpha_to_coverage")
        {
            AlphaToCoverage = ctx.AdvanceBoolean();
        }
        else if (token_name == "colour_write")
        {
            ctx.AdvanceBoolean();
            ctx.WarningNotSupported("colour_write");
        }
        else if (token_name == "depth_func")
        {
            StdStrBuf func;
            ctx.AdvanceRequired(func, TOKEN_IDTF);
            ctx.WarningNotSupported(token_name.getData());
        }
        else if (token_name == "illumination_stage")
        {
            ctx.WarningNotSupported(token_name.getData());
        }
        else if (token_name == "light_clip_planes")
        {
            ctx.AdvanceBoolean();
            ctx.WarningNotSupported(token_name.getData());
        }
        else if (token_name == "light_scissor")
        {
            ctx.AdvanceBoolean();
            ctx.WarningNotSupported(token_name.getData());
        }
        else if (token_name == "lighting")
        {
            ctx.AdvanceBoolean();
            ctx.WarningNotSupported(token_name.getData());
        }
        else if (token_name == "normalise_normals" || token_name == "normalize_normals")
        {
            ctx.AdvanceBoolean();
            ctx.WarningNotSupported(token_name.getData());
        }
        else if (token_name == "polygon_mode")
        {
            StdStrBuf mode;
            ctx.AdvanceRequired(mode, TOKEN_IDTF);
            ctx.WarningNotSupported(token_name.getData());
        }
        else if (token_name == "shading")
        {
            StdStrBuf shading;
            ctx.AdvanceRequired(shading, TOKEN_IDTF);
            ctx.WarningNotSupported(token_name.getData());
        }
        else if (token_name == "transparent_sorting")
        {
            ctx.AdvanceBoolean();
            ctx.WarningNotSupported(token_name.getData());
        }
        else if (token_name == "vertex_program_ref")
        {
            LoadShaderRef(ctx, SMMS_VERTEX);
        }
        else if (token_name == "fragment_program_ref")
        {
            LoadShaderRef(ctx, SMMS_FRAGMENT);
        }
        else if (token_name == "geometry_program_ref")
        {
            LoadShaderRef(ctx, SMMS_GEOMETRY);
        }
        else
            ctx.ErrorUnexpectedIdentifier(token_name);
    }
 
    if (token != TOKEN_BRACE_CLOSE)
        ctx.Error(StdCopyStrBuf("'") + token_name.getData() + "' unexpected");
}

References StdMeshMaterialParserCtx::AdvanceBoolean(), StdMeshMaterialParserCtx::AdvanceColor(), StdMeshMaterialParserCtx::AdvanceEnum(), StdMeshMaterialParserCtx::AdvanceEnums(), StdMeshMaterialParserCtx::AdvanceFloat(), StdMeshMaterialParserCtx::AdvanceFloatOptional(), StdMeshMaterialParserCtx::AdvanceNonEOF(), StdMeshMaterialParserCtx::AdvanceRequired(), AlphaRejectionFunction, AlphaRejectionValue, AlphaToCoverage, Ambient, CullHardware, DepthCheck, DepthWrite, DF_AlwaysFail, DF_AlwaysPass, Diffuse, Emissive, StdMeshMaterialParserCtx::Error(), StdMeshMaterialParserCtx::ErrorUnexpectedIdentifier(), StdStrBuf::getData(), StdMeshMaterialSubLoader::Load(), SceneBlendFactors, Shininess, SMMS_FRAGMENT, SMMS_GEOMETRY, SMMS_VERTEX, Specular, TextureUnits, TOKEN_BRACE_CLOSE, TOKEN_IDTF, and StdMeshMaterialParserCtx::WarningNotSupported().

Here is the call graph for this function:

Member Data Documentation

AlphaRejectionFunction

DepthFunctionType StdMeshMaterialPass::AlphaRejectionFunction

Definition at line 425 of file StdMeshMaterial.h.

Referenced by Load(), and StdMeshMaterialPass().

AlphaRejectionValue

float StdMeshMaterialPass::AlphaRejectionValue

Definition at line 426 of file StdMeshMaterial.h.

Referenced by Load(), and StdMeshMaterialPass().

AlphaToCoverage

bool StdMeshMaterialPass::AlphaToCoverage

Definition at line 427 of file StdMeshMaterial.h.

Referenced by Load(), and StdMeshMaterialPass().

Ambient

float StdMeshMaterialPass::Ambient[4]

Definition at line 414 of file StdMeshMaterial.h.

Referenced by Load(), and StdMeshMaterialPass().

CullHardware

CullHardwareType StdMeshMaterialPass::CullHardware {CH_Clockwise}

Definition at line 423 of file StdMeshMaterial.h.

Referenced by Load().

DepthCheck

bool StdMeshMaterialPass::DepthCheck {true}

Definition at line 420 of file StdMeshMaterial.h.

Referenced by Load().

DepthWrite

bool StdMeshMaterialPass::DepthWrite {true}

Definition at line 421 of file StdMeshMaterial.h.

Referenced by Load().

Diffuse

float StdMeshMaterialPass::Diffuse[4]

Definition at line 415 of file StdMeshMaterial.h.

Referenced by Load(), and StdMeshMaterialPass().

Emissive

float StdMeshMaterialPass::Emissive[4]

Definition at line 417 of file StdMeshMaterial.h.

Referenced by Load(), and StdMeshMaterialPass().

FragmentShader

ShaderInstance StdMeshMaterialPass::FragmentShader

Definition at line 457 of file StdMeshMaterial.h.

Referenced by CStdGL::PrepareMaterial(), and StdMeshMaterialPass().

GeometryShader

ShaderInstance StdMeshMaterialPass::GeometryShader

Definition at line 459 of file StdMeshMaterial.h.

Referenced by CStdGL::PrepareMaterial(), and StdMeshMaterialPass().

Name

StdCopyStrBuf StdMeshMaterialPass::Name

Definition at line 411 of file StdMeshMaterial.h.

Referenced by CStdGL::PrepareMaterial().

Program

std::shared_ptr<ProgramInstance> StdMeshMaterialPass::Program

Definition at line 468 of file StdMeshMaterial.h.

Referenced by CStdGL::PrepareMaterial().

SceneBlendFactors

SceneBlendType StdMeshMaterialPass::SceneBlendFactors[2]

Definition at line 424 of file StdMeshMaterial.h.

Referenced by IsOpaque(), Load(), and StdMeshMaterialPass().

Shininess

float StdMeshMaterialPass::Shininess

Definition at line 418 of file StdMeshMaterial.h.

Referenced by Load(), and StdMeshMaterialPass().

Specular

float StdMeshMaterialPass::Specular[4]

Definition at line 416 of file StdMeshMaterial.h.

Referenced by Load(), and StdMeshMaterialPass().

TextureUnits

std::vector<StdMeshMaterialTextureUnit> StdMeshMaterialPass::TextureUnits

Definition at line 412 of file StdMeshMaterial.h.

Referenced by Load(), CStdGL::PrepareMaterial(), and StdSubMeshInstance::SetMaterial().

VertexShader

ShaderInstance StdMeshMaterialPass::VertexShader

Definition at line 458 of file StdMeshMaterial.h.

Referenced by CStdGL::PrepareMaterial(), and StdMeshMaterialPass().

---

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

• StdMeshMaterial.h
• StdMeshMaterial.cpp