Specialization of HighLevelGpuProgram to provide support for D3D11 High-Level Shader Language (HLSL). More...

#include <OgreD3D11HLSLProgram.h>

Inheritance diagram for Ogre::D3D11HLSLProgram:

Classes
class	CmdColumnMajorMatrices
	Command object for setting matrix packing in column-major order. More...

class	CmdEnableBackwardsCompatibility
	Command object for setting backwards compatibility. More...

class	CmdEntryPoint
	Command object for setting entry point. More...

class	CmdPreprocessorDefines
	Command object for setting macro defines. More...

class	CmdTarget
	Command object for setting target assembler. More...

Public Member Functions
	D3D11HLSLProgram (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader loader, D3D11Device &device)

	~D3D11HLSLProgram () override

void	buildConstantDefinitions () const override
	Build the constant definition map, must be overridden. More...

void	CreateComputeShader ()

void	CreateDomainShader ()

void	CreateGeometryShader ()

void	CreateHullShader ()

GpuProgramParametersSharedPtr	createParameters () override
	Overridden from GpuProgram. More...

void	CreatePixelShader ()

void	CreateVertexShader ()

bool	getColumnMajorMatrices () const
	Gets whether matrix packed in column-major order. More...

const String &	getCompatibleTarget () const
	Gets the shader target promoted to the first compatible, e.g. More...

ID3D11ComputeShader *	getComputeShader () const

void	getConstantBuffers (ID3D11Buffer **buffers, UINT &outSlotStart, UINT &outNumBuffers, GpuProgramParametersSharedPtr params, uint16 variabilityMask)
	buffers must have a capacity of 2, i.e. ID3D11Buffer *buffers[2]; More...

ID3D11DomainShader *	getDomainShader () const

bool	getEnableBackwardsCompatibility () const
	Gets whether backwards compatibility is enabled. More...

const String &	getEntryPoint () const
	Gets the entry point defined for this program. More...

ID3D11GeometryShader *	getGeometryShader () const

ID3D11HullShader *	getHullShader () const

const D3D11_SIGNATURE_PARAMETER_DESC &	getInputParamDesc (size_t index) const

const String &	getLanguage () const override
	Overridden from GpuProgram. More...

ComPtr< ID3D11InputLayout >	getLayoutForPso (const VertexElement2VecVec &vertexElements)

const MicroCode &	getMicroCode () const

String	getNameForMicrocodeCache ()

size_t	getNumInputs () const

size_t	getNumOutputs () const

const D3D11_SIGNATURE_PARAMETER_DESC &	getOutputParamDesc (size_t index) const

ID3D11PixelShader *	getPixelShader () const

const String &	getPreprocessorDefines () const
	Sets the preprocessor defines use to compile the program. More...

unsigned int	getSubroutineSlot (const String &subroutineSlotName) const

const String &	getTarget () const
	Gets the shader target to compile down to, e.g. More...

ID3D11VertexShader *	getVertexShader () const

bool	isSupported () const override
	Overridden from GpuProgram. More...

void	loadFromSource () override
	Internal load implementation, must be implemented by subclasses. More...

void	reinterpretGSForStreamOut ()

void	setColumnMajorMatrices (bool columnMajor)
	Sets whether matrix packing in column-major order. More...

void	setEnableBackwardsCompatibility (bool enableBackwardsCompatibility)
	Sets whether backwards compatibility is enabled. More...

void	setEntryPoint (const String &entryPoint)
	Sets the entry point for this program ie the first method called. More...

void	setPreprocessorDefines (const String &defines)
	Sets the preprocessor defines use to compile the program. More...

void	setTarget (const String &target)
	Sets the shader target to compile down to, e.g. More...

Public Member Functions inherited from Ogre::HighLevelGpuProgram
	HighLevelGpuProgram (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader loader=0)
	Constructor, should be used only by factory classes. More...

	~HighLevelGpuProgram () override

GpuProgram *	_getBindingDelegate () override
	Returns the GpuProgram which should be bound to the pipeline. More...

size_t	calculateSize () const override
	Calculate the size of a resource; this will only be called after 'load'. More...

const GpuNamedConstants &	getConstantDefinitions () const override
	Get the full list of GpuConstantDefinition instances. More...

bool	getEnableIncludeHeader () const

bool	getUseHlmsParser () const

void	setEnableIncludeHeader (bool bEnable)
	Whether we should parse the source code looking for include files and embedding the file. More...

void	setUseHlmsParser (bool bUse)
	Whether we should run the shader through the Hlms parser. More...

Public Member Functions inherited from Ogre::GpuProgram
	GpuProgram (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader loader=0)

	~GpuProgram () override

bool	getBuildParametersFromReflection () const

virtual Vector3	getComputeGroupDimensions () const
	Returns the number of process groups dispatched by this compute program. More...

virtual GpuProgramParametersSharedPtr	getDefaultParameters ()
	Get a reference to the default parameters which are to be used for all uses of this program. More...

virtual const String &	getManualNamedConstantsFile () const
	Gets the name of a file from which to load named parameters mapping for a program which would not be able to derive named parameters itself. More...

virtual ushort	getNumberOfPosesIncluded () const
	Returns the number of simultaneous poses the vertex program can blend, for use in pose animation. More...

uint8	getNumClipDistances () const
	Retrieves the number of clip distances. See GpuProgram::setNumClipDistances. More...

virtual bool	getPassFogStates () const
	Returns whether a fragment program wants fog state to be passed through fixed pipeline low level API rendering calls (default true, subclasses can override) More...

virtual bool	getPassSurfaceAndLightStates () const
	Returns whether a vertex program wants light and material states to be passed through fixed pipeline low level API rendering calls (default false, subclasses can override) More...

virtual bool	getPassTransformStates () const
	Returns whether a vertex program wants transform state to be passed through fixed pipeline low level API rendering calls. More...

virtual const String &	getSource () const
	Gets the assembler source for this program. More...

virtual const String &	getSourceFile () const
	Gets the name of the file used as source for this program. More...

virtual const String &	getSyntaxCode () const
	Gets the syntax code for this program e.g. More...

virtual GpuProgramType	getType () const
	Get the program type. More...

virtual bool	hasCompileError () const
	Did this program encounter a compile error when loading? More...

virtual bool	hasDefaultParameters () const
	Returns true if default parameters have been set up. More...

virtual bool	isMorphAnimationIncluded () const
	Returns whether a vertex program includes the required instructions to perform morph animation. More...

virtual bool	isPoseAnimationIncluded () const
	Returns whether a vertex program includes the required instructions to perform pose animation. More...

virtual bool	isSkeletalAnimationIncluded () const
	Returns whether a vertex program includes the required instructions to perform skeletal animation. More...

virtual bool	isVertexTextureFetchRequired () const
	Returns whether this vertex program requires support for vertex texture fetch from the hardware. More...

virtual bool	isVpAndRtArrayIndexFromAnyShaderRequired () const
	Returns whether this program requires support for choosing viewport or render target index in any program or only geometry one. More...

	OGRE_DEPRECATED_VER (4) virtual bool isAdjacencyInfoRequired() const

	OGRE_DEPRECATED_VER (4) virtual void setAdjacencyInfoRequired(bool r)

virtual void	resetCompileError ()
	Reset a compile error if it occurred, allowing the load to be retried. More...

virtual void	setAutoReflectArrayBindingsInRootLayout (bool bReflectArrayRootLayouts)
	Set to true to reflects the shader looking for array bindings (e.g. More...

void	setBuildParametersFromReflection (bool buildParams)

virtual void	setComputeGroupDimensions (Vector3 dimensions)
	Sets the number of process groups dispatched by this compute program. More...

virtual void	setManualNamedConstants (const GpuNamedConstants &namedConstants)
	Allows you to manually provide a set of named parameter mappings to a program which would not be able to derive named parameters itself. More...

virtual void	setManualNamedConstantsFile (const String &paramDefFile)
	Specifies the name of a file from which to load named parameters mapping for a program which would not be able to derive named parameters itself. More...

virtual void	setMorphAnimationIncluded (bool included)
	Sets whether a vertex program includes the required instructions to perform morph animation. More...

void	setNumClipDistances (const uint8 numClipDistances)
	Sets the number of clip distances this shader uses. More...

virtual void	setPoseAnimationIncluded (ushort poseCount)
	Sets whether a vertex program includes the required instructions to perform pose animation. More...

void	setPrefabRootLayout (const PrefabRootLayout::PrefabRootLayout &prefab)
	Sets a prefab root layout, mostly meant for low level materials (e.g. More...

virtual void	setReplaceVersionMacro (bool bReplace)
	When true: More...

virtual void	setRootLayout (GpuProgramType t, const RootLayout &rootLayout)
	Sets a RootLayout programmatically, thus the shader source won't be parsed looking for one We will call validate() More...

virtual void	setSkeletalAnimationIncluded (bool included)
	Sets whether a vertex program includes the required instructions to perform skeletal animation. More...

virtual void	setSource (const String &source)
	Sets the source assembly for this program from an in-memory string. More...

virtual void	setSource (const String &source, const String &debugFilename)
	Sets the source assembly for this program from an in-memory string, while providing a path to a file, which can be needed/useful for debugging shaders (i.e. More...

virtual void	setSourceFile (const String &filename)
	Sets the filename of the source assembly for this program. More...

virtual void	setSyntaxCode (const String &syntax)
	Sets the syntax code for this program e.g. More...

virtual void	setType (GpuProgramType t)
	Set the program type (only valid before load) More...

virtual void	setUniformBlockBinding (const char *blockName, uint32 bindingSlot)
	For GL only. Program must be bound when calling. More...

virtual void	setVertexTextureFetchRequired (bool r)
	Sets whether this vertex program requires support for vertex texture fetch from the hardware. More...

virtual void	setVpAndRtArrayIndexFromAnyShaderRequired (bool r)
	Sets whether this program requires support for choosing viewport or render target index in any program or only geometry one. More...

virtual void	unsetRootLayout ()

Public Member Functions inherited from Ogre::Resource
	Resource (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader loader=0)
	Standard constructor. More...

virtual	~Resource ()
	Virtual destructor. More...

virtual void	_dirtyState ()
	Manually mark the state of this resource as having been changed. More...

virtual void	_fireLoadingComplete (bool wasBackgroundLoaded)
	Firing of loading complete event. More...

virtual void	_firePreparingComplete (bool wasBackgroundLoaded)
	Firing of preparing complete event. More...

virtual void	_fireUnloadingComplete ()
	Firing of unloading complete event. More...

virtual void	_notifyOrigin (const String &origin)
	Notify this resource of it's origin. More...

virtual void	addListener (Listener *lis)
	Register a listener on this resource. More...

virtual void	changeGroupOwnership (const String &newGroup)
	Change the resource group ownership of a Resource. More...

virtual void	escalateLoading ()
	Escalates the loading of a background loaded resource. More...

virtual ResourceManager *	getCreator ()
	Gets the manager which created this resource. More...

virtual const String &	getGroup () const
	Gets the group which this resource is a member of. More...

virtual ResourceHandle	getHandle () const

virtual LoadingState	getLoadingState () const
	Returns the current loading state. More...

virtual const String &	getName () const
	Gets resource name. More...

virtual const String &	getOrigin () const
	Get the origin of this resource, e.g. More...

virtual size_t	getSize () const
	Retrieves info about the size of the resource. More...

virtual size_t	getStateCount () const
	Returns the number of times this resource has changed state, which generally means the number of times it has been loaded. More...

virtual bool	isBackgroundLoaded () const
	Returns whether this Resource has been earmarked for background loading. More...

virtual bool	isLoaded () const
	Returns true if the Resource has been loaded, false otherwise. More...

virtual bool	isLoading () const
	Returns whether the resource is currently in the process of background loading. More...

virtual bool	isManuallyLoaded () const
	Is this resource manually loaded? More...

virtual bool	isPrepared () const
	Returns true if the Resource has been prepared, false otherwise. More...

virtual bool	isReloadable () const
	Returns true if the Resource is reloadable, false otherwise. More...

virtual void	load (bool backgroundThread=false)
	Loads the resource, if it is not already. More...

bool	markForReload ()

virtual void	prepare (bool backgroundThread=false)
	Prepares the resource for load, if it is not already. More...

virtual void	reload (LoadingFlags flags=LF_DEFAULT)
	Reloads the resource, if it is already loaded. More...

virtual void	removeListener (Listener *lis)
	Remove a listener on this resource. More...

virtual void	setBackgroundLoaded (bool bl)
	Tells the resource whether it is background loaded or not. More...

virtual void	setManuallyLoaded (bool isManual)
	Set "Is this resource manually loaded?". More...

virtual void	setToLoaded ()
	Change the Resource loading state to loaded. More...

virtual void	touch ()
	'Touches' the resource to indicate it has been used. More...

virtual void	unload ()
	Unloads the resource; this is not permanent, the resource can be reloaded later if required. More...

Public Member Functions inherited from Ogre::StringInterface
	StringInterface ()

virtual	~StringInterface ()
	Virtual destructor, see Effective C++. More...

virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object. More...

ParamDictionary *	getParamDictionary ()
	Retrieves the parameter dictionary for this class. More...

const ParamDictionary *	getParamDictionary () const

virtual String	getParameter (const String &name) const
	Generic parameter retrieval method. More...

const ParameterList &	getParameters () const
	Retrieves a list of parameters valid for this object. More...

virtual bool	setParameter (const String &name, const String &value)
	Generic parameter setting method. More...

virtual void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method. More...

Public Attributes
bool	mReinterpretingGS

Public Attributes inherited from Ogre::Resource
	OGRE_AUTO_MUTEX

Additional Inherited Members
Public Types inherited from Ogre::Resource
enum	LoadingFlags { LF_DEFAULT = 0 , LF_INCLUDE_NON_RELOADABLE = 1 , LF_ONLY_UNREFERENCED = 2 , LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE = 3 , LF_PRESERVE_STATE = 4 , LF_MARKED_FOR_RELOAD = 8 }
	Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior. More...

enum	LoadingState { LOADSTATE_UNLOADED , LOADSTATE_LOADING , LOADSTATE_LOADED , LOADSTATE_UNLOADING , LOADSTATE_PREPARED , LOADSTATE_PREPARING , LOADSTATE_UNLOADED_MARKED_FOR_RELOAD }
	Enum identifying the loading state of the resource. More...

Static Public Member Functions inherited from Ogre::StringInterface
static void	cleanupDictionary ()
	Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More...

Static Public Attributes inherited from Ogre::HighLevelGpuProgram
static CmdEnableIncludeHeader	msEnableIncludeHeaderCmd

static CmdUseHlmsParser	msUseHlmsParser

Detailed Description

Specialization of HighLevelGpuProgram to provide support for D3D11 High-Level Shader Language (HLSL).

Remarks: Note that the syntax of D3D11 HLSL is identical to nVidia's Cg language, therefore unless you know you will only ever be deploying on Direct3D, or you have some specific reason for not wanting to use the Cg plugin, I suggest you use Cg instead since that can produce programs for OpenGL too.

Constructor & Destructor Documentation

◆ D3D11HLSLProgram()

Ogre::D3D11HLSLProgram::D3D11HLSLProgram	(	ResourceManager *	creator,
		const String &	name,
		ResourceHandle	handle,
		const String &	group,
		bool	isManual,
		ManualResourceLoader *	loader,
		D3D11Device &	device
	)

◆ ~D3D11HLSLProgram()

Ogre::D3D11HLSLProgram::~D3D11HLSLProgram ( )

override

Member Function Documentation

◆ buildConstantDefinitions()

void Ogre::D3D11HLSLProgram::buildConstantDefinitions ( ) const

overridevirtual

Build the constant definition map, must be overridden.

Note: The implementation must fill in the (inherited) mConstantDefs field at a minimum, and if the program requires that parameters are bound using logical parameter indexes then the mFloatLogicalToPhysical and mIntLogicalToPhysical maps must also be populated.

Implements Ogre::HighLevelGpuProgram.

◆ CreateComputeShader()

void Ogre::D3D11HLSLProgram::CreateComputeShader ( )

◆ CreateDomainShader()

void Ogre::D3D11HLSLProgram::CreateDomainShader ( )

◆ CreateGeometryShader()

void Ogre::D3D11HLSLProgram::CreateGeometryShader ( )

◆ CreateHullShader()

void Ogre::D3D11HLSLProgram::CreateHullShader ( )

◆ createParameters()

GpuProgramParametersSharedPtr Ogre::D3D11HLSLProgram::createParameters ( )

overridevirtual

Overridden from GpuProgram.

Reimplemented from Ogre::HighLevelGpuProgram.

◆ CreatePixelShader()

void Ogre::D3D11HLSLProgram::CreatePixelShader ( )

◆ CreateVertexShader()

void Ogre::D3D11HLSLProgram::CreateVertexShader ( )

◆ getColumnMajorMatrices()

bool Ogre::D3D11HLSLProgram::getColumnMajorMatrices ( ) const

inline

Gets whether matrix packed in column-major order.

◆ getCompatibleTarget()

const String& Ogre::D3D11HLSLProgram::getCompatibleTarget ( ) const

Gets the shader target promoted to the first compatible, e.g.

'vs_4_0' or 'ps_4_0' if backward compatibility is enabled.

◆ getComputeShader()

ID3D11ComputeShader* Ogre::D3D11HLSLProgram::getComputeShader ( ) const

◆ getConstantBuffers()

void Ogre::D3D11HLSLProgram::getConstantBuffers	(	ID3D11Buffer **	buffers,
		UINT &	outSlotStart,
		UINT &	outNumBuffers,
		GpuProgramParametersSharedPtr	params,
		uint16	variabilityMask
	)

buffers must have a capacity of 2, i.e. ID3D11Buffer *buffers[2];

◆ getDomainShader()

ID3D11DomainShader* Ogre::D3D11HLSLProgram::getDomainShader ( ) const

◆ getEnableBackwardsCompatibility()

bool Ogre::D3D11HLSLProgram::getEnableBackwardsCompatibility ( ) const

inline

Gets whether backwards compatibility is enabled.

◆ getEntryPoint()

const String& Ogre::D3D11HLSLProgram::getEntryPoint ( ) const

inline

Gets the entry point defined for this program.

◆ getGeometryShader()

ID3D11GeometryShader* Ogre::D3D11HLSLProgram::getGeometryShader ( ) const

◆ getHullShader()

ID3D11HullShader* Ogre::D3D11HLSLProgram::getHullShader ( ) const

◆ getInputParamDesc()

const D3D11_SIGNATURE_PARAMETER_DESC& Ogre::D3D11HLSLProgram::getInputParamDesc ( size_t index ) const

◆ getLanguage()

const String& Ogre::D3D11HLSLProgram::getLanguage ( ) const

overridevirtual

Overridden from GpuProgram.

Reimplemented from Ogre::GpuProgram.

◆ getLayoutForPso()

ComPtr<ID3D11InputLayout> Ogre::D3D11HLSLProgram::getLayoutForPso ( const VertexElement2VecVec & vertexElements )

◆ getMicroCode()

const MicroCode& Ogre::D3D11HLSLProgram::getMicroCode ( ) const

◆ getNameForMicrocodeCache()

String Ogre::D3D11HLSLProgram::getNameForMicrocodeCache ( )

◆ getNumInputs()

size_t Ogre::D3D11HLSLProgram::getNumInputs ( ) const

◆ getNumOutputs()

size_t Ogre::D3D11HLSLProgram::getNumOutputs ( ) const

◆ getOutputParamDesc()

const D3D11_SIGNATURE_PARAMETER_DESC& Ogre::D3D11HLSLProgram::getOutputParamDesc ( size_t index ) const

◆ getPixelShader()

ID3D11PixelShader* Ogre::D3D11HLSLProgram::getPixelShader ( ) const

◆ getPreprocessorDefines()

const String& Ogre::D3D11HLSLProgram::getPreprocessorDefines ( ) const

inline

Sets the preprocessor defines use to compile the program.

◆ getSubroutineSlot()

unsigned int Ogre::D3D11HLSLProgram::getSubroutineSlot ( const String & subroutineSlotName ) const

◆ getTarget()

const String& Ogre::D3D11HLSLProgram::getTarget ( ) const

inline

Gets the shader target to compile down to, e.g.

'vs_1_1'.

◆ getVertexShader()

ID3D11VertexShader* Ogre::D3D11HLSLProgram::getVertexShader ( ) const

◆ isSupported()

bool Ogre::D3D11HLSLProgram::isSupported ( ) const

overridevirtual

Overridden from GpuProgram.

Reimplemented from Ogre::GpuProgram.

◆ loadFromSource()

void Ogre::D3D11HLSLProgram::loadFromSource ( )

overridevirtual

Internal load implementation, must be implemented by subclasses.

Implements Ogre::GpuProgram.

◆ reinterpretGSForStreamOut()

void Ogre::D3D11HLSLProgram::reinterpretGSForStreamOut ( )

◆ setColumnMajorMatrices()

void Ogre::D3D11HLSLProgram::setColumnMajorMatrices ( bool columnMajor )

inline

Sets whether matrix packing in column-major order.

◆ setEnableBackwardsCompatibility()

void Ogre::D3D11HLSLProgram::setEnableBackwardsCompatibility ( bool enableBackwardsCompatibility )

inline

Sets whether backwards compatibility is enabled.

◆ setEntryPoint()

void Ogre::D3D11HLSLProgram::setEntryPoint ( const String & entryPoint )

inline

Sets the entry point for this program ie the first method called.

◆ setPreprocessorDefines()

void Ogre::D3D11HLSLProgram::setPreprocessorDefines ( const String & defines )

inline

Sets the preprocessor defines use to compile the program.

◆ setTarget()

void Ogre::D3D11HLSLProgram::setTarget ( const String & target )

Sets the shader target to compile down to, e.g.

'vs_1_1'.

Member Data Documentation

◆ mReinterpretingGS

bool Ogre::D3D11HLSLProgram::mReinterpretingGS

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

OgreD3D11HLSLProgram.h

Classes

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ D3D11HLSLProgram()

◆ ~D3D11HLSLProgram()

Member Function Documentation

◆ buildConstantDefinitions()

◆ CreateComputeShader()

◆ CreateDomainShader()

◆ CreateGeometryShader()

◆ CreateHullShader()

◆ createParameters()

◆ CreatePixelShader()

◆ CreateVertexShader()

◆ getColumnMajorMatrices()

◆ getCompatibleTarget()

◆ getComputeShader()

◆ getConstantBuffers()

◆ getDomainShader()

◆ getEnableBackwardsCompatibility()

◆ getEntryPoint()

◆ getGeometryShader()

◆ getHullShader()

◆ getInputParamDesc()

◆ getLanguage()

◆ getLayoutForPso()

◆ getMicroCode()

◆ getNameForMicrocodeCache()

◆ getNumInputs()

◆ getNumOutputs()

◆ getOutputParamDesc()

◆ getPixelShader()

◆ getPreprocessorDefines()

◆ getSubroutineSlot()

◆ getTarget()

◆ getVertexShader()

◆ isSupported()

◆ loadFromSource()

◆ reinterpretGSForStreamOut()

◆ setColumnMajorMatrices()

◆ setEnableBackwardsCompatibility()

◆ setEntryPoint()

◆ setPreprocessorDefines()

◆ setTarget()

Member Data Documentation

◆ mReinterpretingGS