Defines options for rendering using a material instance. More...

#include <MaterialOptions.h>

Public Attributes
CullMode	cullMode = CullMode::Back
	Primitive culling mode to use.

bool	depthWriteEnabled = true
	If depth writes should be enabled rendering the geometry with the material instance.

bool	depthTestEnabled = true
	If depth testing should be enabled rendering the geometry with the material instance.

DepthFunc	depthFunc = DepthFunc::Less
	Depth test should pass when the incoming depth is less than current value in depth buffer.

bool	depthBiasEnabled = false
	If depth bias should be enabled.

DepthBias	depthBias
	Depth bias control values, only applicable if depthBiasEnabled is true.

TransparencyMode	transparencyMode = TransparencyMode::None
	Transparency mode.

BlendMode	blendMode = BlendMode::None
	Blend mode to use when rendering geometry with the material instance.

int32_t	drawOrder = 0

Detailed Description

Defines options for rendering using a material instance.

Definition at line 93 of file MaterialOptions.h.

Member Data Documentation

◆ blendMode

BlendMode Cogs::Core::MaterialOptions::blendMode = BlendMode::None

Blend mode to use when rendering geometry with the material instance.

Definition at line 117 of file MaterialOptions.h.

Referenced by Cogs::Core::SpriteRenderSystem::initialize(), and Cogs::Core::TextSystem::initialize().

◆ cullMode

CullMode Cogs::Core::MaterialOptions::cullMode = CullMode::Back

Primitive culling mode to use.

Definition at line 96 of file MaterialOptions.h.

◆ depthBias

DepthBias Cogs::Core::MaterialOptions::depthBias

Depth bias control values, only applicable if depthBiasEnabled is true.

Definition at line 111 of file MaterialOptions.h.

◆ depthBiasEnabled

bool Cogs::Core::MaterialOptions::depthBiasEnabled = false

If depth bias should be enabled.

Definition at line 108 of file MaterialOptions.h.

◆ depthFunc

DepthFunc Cogs::Core::MaterialOptions::depthFunc = DepthFunc::Less

Depth test should pass when the incoming depth is less than current value in depth buffer.

Definition at line 105 of file MaterialOptions.h.

◆ depthTestEnabled

bool Cogs::Core::MaterialOptions::depthTestEnabled = true

If depth testing should be enabled rendering the geometry with the material instance.

Definition at line 102 of file MaterialOptions.h.

Referenced by Cogs::Core::Image360System::update().

◆ depthWriteEnabled

bool Cogs::Core::MaterialOptions::depthWriteEnabled = true

If depth writes should be enabled rendering the geometry with the material instance.

Definition at line 99 of file MaterialOptions.h.

Referenced by Cogs::Core::SpriteRenderSystem::initialize(), Cogs::Core::TextSystem::initialize(), and Cogs::Core::EchoSounder::UniformGridSystem::preUpdate().

◆ drawOrder

int32_t Cogs::Core::MaterialOptions::drawOrder = 0

Optional draw ordering within a render bucket.

When draw order matters, it can be adjusted with this value. Items are drawn from smaller number to larger numbers, i.e. -10 is drawn before 0, which is the default draw order, and 10 is drawn after that.

That is, drawOrder 10 is in front of drawOrder 0 which is in front of draw order -10.

If draw order is zero, the render component's draw order will be used instead.

Definition at line 131 of file MaterialOptions.h.

◆ transparencyMode

TransparencyMode Cogs::Core::MaterialOptions::transparencyMode = TransparencyMode::None

Transparency mode.

Definition at line 114 of file MaterialOptions.h.

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

Source/Resources/MaterialOptions.h

Public Attributes