Cogs::EffectDescription Struct Reference

Contains an effect description used to load a single effect. More...

#include <IEffects.h>

Public Attributes
StringView	vertexShader
	Vertex shader file name or source.
StringView	hullShader
	Hull shader file name or source.
StringView	domainShader
	Domain shader file name or source.
StringView	geometryShader
	Geometry shader file name or source.
StringView	pixelShader
	Pixel shader file name or source.
StringView	effect
	Effect file name or source.
StringView	vsEntryPoint
	Entry point of the vertex shader.
StringView	hsEntryPoint
	Entry point of the hull shader.
StringView	dsEntryPoint
	Entry point of the domain shader.
StringView	gsEntryPoint
	Entry point of the geometry shader.
StringView	psEntryPoint
	Entry point of the pixel shader.
StringView	name
	Name of the effect. Used for tracking purposes, like naming shader dumps.
PreprocessorDefinitions	definitions
	Definitions.
BindGroupSetDescription	bindGroupLayoutDesc
	Optional bind-group layout metadata. Backends may use this instead of source introspection.
EffectFlags::EEffectFlags	flags = EffectFlags::None
	Effect loading flags.
EffectDescriptionType	type = EffectDescriptionType::File
	Type of effect description. Defaults to file names.

Detailed Description

Contains an effect description used to load a single effect.

Definition at line 61 of file IEffects.h.

Member Data Documentation

bindGroupLayoutDesc

BindGroupSetDescription Cogs::EffectDescription::bindGroupLayoutDesc

Optional bind-group layout metadata. Backends may use this instead of source introspection.

Definition at line 103 of file IEffects.h.

definitions

PreprocessorDefinitions Cogs::EffectDescription::definitions

Definitions.

Definition at line 100 of file IEffects.h.

domainShader

StringView Cogs::EffectDescription::domainShader

Domain shader file name or source.

Definition at line 70 of file IEffects.h.

Referenced by Cogs::EffectsCommon::loadEffect().

dsEntryPoint

StringView Cogs::EffectDescription::dsEntryPoint

Entry point of the domain shader.

Definition at line 88 of file IEffects.h.

effect

StringView Cogs::EffectDescription::effect

Effect file name or source.

Definition at line 79 of file IEffects.h.

Referenced by Cogs::EffectsCommon::loadEffect().

flags

EffectFlags::EEffectFlags Cogs::EffectDescription::flags = EffectFlags::None

Effect loading flags.

Definition at line 106 of file IEffects.h.

geometryShader

StringView Cogs::EffectDescription::geometryShader

Geometry shader file name or source.

Definition at line 73 of file IEffects.h.

Referenced by Cogs::EffectsCommon::loadEffect().

gsEntryPoint

StringView Cogs::EffectDescription::gsEntryPoint

Entry point of the geometry shader.

Definition at line 91 of file IEffects.h.

hsEntryPoint

StringView Cogs::EffectDescription::hsEntryPoint

Entry point of the hull shader.

Definition at line 85 of file IEffects.h.

hullShader

StringView Cogs::EffectDescription::hullShader

Hull shader file name or source.

Definition at line 67 of file IEffects.h.

Referenced by Cogs::EffectsCommon::loadEffect().

name

StringView Cogs::EffectDescription::name

Name of the effect. Used for tracking purposes, like naming shader dumps.

Definition at line 97 of file IEffects.h.

pixelShader

StringView Cogs::EffectDescription::pixelShader

Pixel shader file name or source.

Definition at line 76 of file IEffects.h.

Referenced by Cogs::EffectsCommon::loadEffect().

psEntryPoint

StringView Cogs::EffectDescription::psEntryPoint

Entry point of the pixel shader.

Definition at line 94 of file IEffects.h.

type

EffectDescriptionType Cogs::EffectDescription::type = EffectDescriptionType::File

Type of effect description. Defaults to file names.

Definition at line 109 of file IEffects.h.

Referenced by Cogs::EffectsCommon::loadEffect().

vertexShader

StringView Cogs::EffectDescription::vertexShader

Vertex shader file name or source.

Definition at line 64 of file IEffects.h.

Referenced by Cogs::EffectsCommon::loadEffect().

vsEntryPoint

StringView Cogs::EffectDescription::vsEntryPoint

Entry point of the vertex shader.

Definition at line 82 of file IEffects.h.

---

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

• D:/a/1/s/Cogs/Cogs.Rendering/Source/IEffects.h