OGRE-Next  3.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::VulkanProgram Class Referencefinal

Specialisation of HighLevelGpuProgram to provide support for Vulkan Shader Language. More...

#include <OgreVulkanProgram.h>

+ Inheritance diagram for Ogre::VulkanProgram:

Classes

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

Public Member Functions

 VulkanProgram (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, VulkanDevice *device, String &languageName)
 
 ~VulkanProgram () override
 
bool compile (const bool checkErrors, const bool bReflectingArrays=false)
 Compile source into shader object. More...
 
GpuProgramParametersSharedPtr createParameters () override
 Overridden from GpuProgram. More...
 
void debugDump (String &outString)
 
void fillPipelineShaderStageCi (VkPipelineShaderStageCreateInfo &pssCi)
 
uint32 getBufferRequiredSize () const
 In bytes. More...
 
const map< uint32, VulkanConstantDefinitionBindingParam >::type & getConstantDefsBindingParams () const
 
uint32 getDrawIdLocation () const
 
const StringgetLanguage () const override
 Overridden from GpuProgram. More...
 
void getLayoutForPso (const VertexElement2VecVec &vertexElements, FastArray< VkVertexInputBindingDescription > &outBufferBindingDescs, FastArray< VkVertexInputAttributeDescription > &outVertexInputs)
 
bool getPassFogStates () const override
 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...
 
bool getPassSurfaceAndLightStates () const override
 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...
 
bool getPassTransformStates () const override
 Overridden. More...
 
const StringgetPreprocessorDefines () const
 Sets the preprocessor defines use to compile the program. More...
 
VulkanRootLayoutgetRootLayout ()
 
const std::vector< uint32 > & getSpirv () const
 
void setAutoReflectArrayBindingsInRootLayout (bool bReflectArrayRootLayouts) override
 Set to true to reflects the shader looking for array bindings (e.g. More...
 
void setPreprocessorDefines (const String &defines)
 Sets the preprocessor defines use to compile the program. More...
 
void setReplaceVersionMacro (bool bReplace) override
 When true: More...
 
void setRootLayout (GpuProgramType type, const RootLayout &rootLayout) override
 Sets a RootLayout programmatically, thus the shader source won't be parsed looking for one We will call validate() More...
 
void unsetRootLayout () override
 
void updateBuffers (const GpuProgramParametersSharedPtr &params, uint8 *RESTRICT_ALIAS dstData)
 dstData must be able to hold at least getBufferRequiredSize 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 GpuNamedConstantsgetConstantDefinitions () 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 StringgetManualNamedConstantsFile () 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 const StringgetSource () const
 Gets the assembler source for this program. More...
 
virtual const StringgetSourceFile () const
 Gets the name of the file used as source for this program. More...
 
virtual const StringgetSyntaxCode () 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 isAdjacencyInfoRequired () const
 Returns whether this geometry program requires adjacency information from the input primitives. 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 isSupported () const
 Returns whether this program can be supported on the current renderer and hardware. 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...
 
virtual void resetCompileError ()
 Reset a compile error if it occurred, allowing the load to be retried. More...
 
virtual void setAdjacencyInfoRequired (bool r)
 Sets whether this geometry program requires adjacency information from the input primitives. 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 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...
 
- 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 ResourceManagergetCreator ()
 Gets the manager which created this resource. More...
 
virtual const StringgetGroup () 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 StringgetName () const
 Gets resource name. More...
 
virtual const StringgetOrigin () 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...
 
ParamDictionarygetParamDictionary ()
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary () const
 
virtual String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters () 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...
 

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...
 
- Public Attributes inherited from Ogre::Resource
 OGRE_AUTO_MUTEX
 
- Static Public Attributes inherited from Ogre::HighLevelGpuProgram
static CmdEnableIncludeHeader msEnableIncludeHeaderCmd
 
static CmdUseHlmsParser msUseHlmsParser
 

Detailed Description

Specialisation of HighLevelGpuProgram to provide support for Vulkan Shader Language.

Remarks
Vulkan has no target assembler or entry point specification like DirectX 9 HLSL. Vertex and Fragment shaders only have one entry point called "main". When a shader is compiled, microcode is generated but can not be accessed by the application. Vulkan also does not provide assembler low level output after compiling. The Vulkan Render system assumes that the Gpu program is a Vulkan Gpu program so VulkanProgram will create a VulkanGpuProgram that is subclassed from VulkanGpuProgram for the low level implementation. The VulkanProgram class will create a shader object and compile the source but will not create a program object. It's up to VulkanGpuProgram class to request a program object to link the shader object to.

Constructor & Destructor Documentation

◆ VulkanProgram()

Ogre::VulkanProgram::VulkanProgram ( ResourceManager creator,
const String name,
ResourceHandle  handle,
const String group,
bool  isManual,
ManualResourceLoader loader,
VulkanDevice device,
String languageName 
)

◆ ~VulkanProgram()

Ogre::VulkanProgram::~VulkanProgram ( )
override

Member Function Documentation

◆ compile()

bool Ogre::VulkanProgram::compile ( const bool  checkErrors,
const bool  bReflectingArrays = false 
)

Compile source into shader object.

◆ createParameters()

GpuProgramParametersSharedPtr Ogre::VulkanProgram::createParameters ( )
overridevirtual

Overridden from GpuProgram.

Reimplemented from Ogre::HighLevelGpuProgram.

◆ debugDump()

void Ogre::VulkanProgram::debugDump ( String outString)

◆ fillPipelineShaderStageCi()

void Ogre::VulkanProgram::fillPipelineShaderStageCi ( VkPipelineShaderStageCreateInfo &  pssCi)

◆ getBufferRequiredSize()

uint32 Ogre::VulkanProgram::getBufferRequiredSize ( ) const

In bytes.

◆ getConstantDefsBindingParams()

const map<uint32, VulkanConstantDefinitionBindingParam>::type& Ogre::VulkanProgram::getConstantDefsBindingParams ( ) const
inline

◆ getDrawIdLocation()

uint32 Ogre::VulkanProgram::getDrawIdLocation ( ) const
inline

◆ getLanguage()

const String& Ogre::VulkanProgram::getLanguage ( ) const
overridevirtual

Overridden from GpuProgram.

Reimplemented from Ogre::GpuProgram.

◆ getLayoutForPso()

void Ogre::VulkanProgram::getLayoutForPso ( const VertexElement2VecVec vertexElements,
FastArray< VkVertexInputBindingDescription > &  outBufferBindingDescs,
FastArray< VkVertexInputAttributeDescription > &  outVertexInputs 
)

◆ getPassFogStates()

bool Ogre::VulkanProgram::getPassFogStates ( ) const
overridevirtual

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

Remarks
On DirectX, shader model 2 and earlier continues to have fixed-function fog applied to it, so fog state is still passed (you should disable fog on the pass if you want to perform fog in the shader). In OpenGL it is also common to be able to access the fixed-function fog state inside the shader.

Reimplemented from Ogre::GpuProgram.

◆ getPassSurfaceAndLightStates()

bool Ogre::VulkanProgram::getPassSurfaceAndLightStates ( ) const
overridevirtual

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)

Remarks
Most vertex programs do not need this material information, however GLSL shaders can refer to this material and lighting state so enable this option

Reimplemented from Ogre::GpuProgram.

◆ getPassTransformStates()

bool Ogre::VulkanProgram::getPassTransformStates ( ) const
overridevirtual

Overridden.

Reimplemented from Ogre::GpuProgram.

◆ getPreprocessorDefines()

const String& Ogre::VulkanProgram::getPreprocessorDefines ( ) const
inline

Sets the preprocessor defines use to compile the program.

◆ getRootLayout()

VulkanRootLayout* Ogre::VulkanProgram::getRootLayout ( )
inline

◆ getSpirv()

const std::vector<uint32>& Ogre::VulkanProgram::getSpirv ( ) const
inline

◆ setAutoReflectArrayBindingsInRootLayout()

void Ogre::VulkanProgram::setAutoReflectArrayBindingsInRootLayout ( bool  bReflectArrayRootLayouts)
overridevirtual

Set to true to reflects the shader looking for array bindings (e.g.

uniform texture2D myTex[123]) to patch the Root Layout

Parameters
bReflectArrayRootLayoutsWhen true (default), reflect the shader to see if the RootLayout needs patching to include array bindings

When false, we assume the RootLayout doesn't need patching and array bindings are correct. Failure to do this right may result in shader compiler errors OR everything appears fine but Vulkan Validation Layers detect it

In debug builds we will validate and reflect anyway to detect wrong usage

Reimplemented from Ogre::GpuProgram.

◆ setPreprocessorDefines()

void Ogre::VulkanProgram::setPreprocessorDefines ( const String defines)
inline

Sets the preprocessor defines use to compile the program.

◆ setReplaceVersionMacro()

void Ogre::VulkanProgram::setReplaceVersionMacro ( bool  bReplace)
overridevirtual

When true:

On OpenGL: Finds the first occurrence of "ogre_glsl_ver_xxx" and only keeps "xxx" e.g. ogre_glsl_ver_330 becomes 330, ogre_glsl_ver_430 becomes 430

On Vulkan: Finds the first occurrence of "ogre_glsl_ver_xxx" and replaces it with "450"

This is disabled by default because we must scan the entire source and it's just wasted cycles when using Hlms.

However it is enabled by default on low level materials, because their source length tends to be very short and it is extremely useful/practical there

Parameters
bReplace

Reimplemented from Ogre::GpuProgram.

◆ setRootLayout()

void Ogre::VulkanProgram::setRootLayout ( GpuProgramType  t,
const RootLayout rootLayout 
)
overridevirtual

Sets a RootLayout programmatically, thus the shader source won't be parsed looking for one We will call validate()

Do not alter the type after calling this function.

This setting will be cleared if the program gets unloaded

Reimplemented from Ogre::GpuProgram.

◆ unsetRootLayout()

void Ogre::VulkanProgram::unsetRootLayout ( )
overridevirtual

Reimplemented from Ogre::GpuProgram.

◆ updateBuffers()

void Ogre::VulkanProgram::updateBuffers ( const GpuProgramParametersSharedPtr params,
uint8 *RESTRICT_ALIAS  dstData 
)

dstData must be able to hold at least getBufferRequiredSize


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