Compute shader object. More...

#include <RV_ShaderProgram.h>

Inheritance diagram for RV_ShaderCompute:

Public Member Functions
RV_ShaderType	getShaderType () const override
	Type of shader - graphics or compute. More...

	~RV_ShaderCompute () override

const UT_Vector3i &	getWorkGroupSize () const

bool	hasWorkGroupSpecializationConst () const

bool	prepareForDraw (RV_Instance inst, RV_VKCommandBuffer cb)

void	print () const override
	Debug print message. More...

Public Member Functions inherited from RV_ShaderProgramBase
	RV_ShaderProgramBase (RV_Instance *inst, RV_VKPipelineLayoutPtr pipe_layout)

virtual	~RV_ShaderProgramBase ()

void	setName (const UT_StringHolder &name)
	Set a descriptive name for the shader. More...

const UT_StringHolder &	name () const
	Descriptive name of the shader. More...

const UT_Array< exint > &	layoutIds () const

int	getMaxSetNumber () const
	The number of descriptor sets in the shader. More...

bool	hasSet (int set_num) const
	Query if set 'set_num' is used by the shader. More...

bool	isSetCompatible (const RV_ShaderVariableSet &set) const
	Return true if 'set' is compatable with the set layout in this shader. More...

const RV_VKDescriptorSetInfo *	getSetInfo (int set_num) const
	Query information on set 'set_num'. More...

UT_UniquePtr < RV_ShaderVariableSet >	createSet (RV_Instance *inst, int set_num) const
	Create a shader varaible set (descriptor set) for set 'set_num'. More...

const RV_VKPipelineLayout &	getLayout () const
	The layout of all sets and inputs of the shader. More...

bool	hasBinding (const UT_StringRef &name) const
	Query if a binding named 'name' exists. More...

const RV_VKDescriptorBinding *	getBinding (int set, int binding) const
	Return a binding at index 'binding' for set index 'set'. More...

const RV_VKDescriptorBinding *	getBinding (const UT_StringRef &name) const
	Return a binding for 'name'. More...

const UT_Array< const RV_VKDescriptorBinding * > &	getBindingList () const
	Return the list of set bindings. More...

bool	hasUniform (const UT_StringRef &name) const
	Query if the uniform named 'name' exists. More...

const RV_Uniform *	getUniform (const UT_StringRef &name) const
	Return type, size, and offset information about the uniform. More...

const UT_Array< const RV_Uniform * > &	getUniformList () const
	Return a list of all uniforms in this shader. More...

bool	hasPushConstant (const UT_StringRef &name) const
	Query if push constant with 'name' exists. More...

const RV_Uniform *	getPushConstant (const UT_StringRef &name, int *opt_idx) const
	Fetch the push constant 'name' with an optional array index. More...

const UT_Array < RV_VKPushConstantRange > &	getPushConstantRanges () const

Static Public Member Functions
static RV_ShaderCompute *	loadShaderProgram (RV_Instance inst, const char program, const char *extra_defines=nullptr)

static RV_ShaderCompute *	createShaderProgram (RV_Instance *inst, RV_VKShader &shader)
	Create Shader using GLSL to SPIR-V compiler object. More...

static RV_ShaderCompute *	createShaderProgram (RV_Instance *inst, const UT_StringArray &filenames)
	Create Shader using list of SPIR-V binary filenames. More...

static RV_ShaderCompute *	createShaderProgram (RV_Instance *inst, UT_Array< RV_VKShaderModuleInfoPtr > &rv_modules)
	Create Shader using list of SPIR-V modules. More...

static RV_ShaderCompute *	createShaderProgram (RV_Instance *inst, RV_VKPipelineLayoutPtr layout)

Protected Member Functions
	RV_ShaderCompute (RV_Instance *inst, RV_VKPipelineLayoutPtr pipe_layout, RV_VKPipelinePtr pipeline)

Protected Attributes
UT_UniquePtr< RV_VKPipeline >	myPipeline

Protected Attributes inherited from RV_ShaderProgramBase
UT_Array< RV_ShaderInput >	myInputs

UT_ArrayStringMap< int >	myInputTable

UT_UniquePtr< const RV_VKPipelineLayout >	myLayout

UT_SmallArray< exint, 8 *sizeof(exint)>	mySetLayoutIds

UT_Array< const RV_Uniform * >	myUniforms

UT_ArrayStringMap< int >	myUniformTable
	Mapping of uniform names, to indices in myUniforms. More...

UT_Array< const RV_VKDescriptorBinding * >	myBindings

UT_ArrayStringMap< std::pair < int, int > >	myBindingTable
	mapping of binding name to set + binding number More...

UT_Array< const RV_Uniform * >	myPushConstants

UT_ArrayStringMap< int >	myPushConstTable

UT_StringHolder	myName

friend	RV_Geometry

friend	RV_ShaderVariableSet

Additional Inherited Members
Static Protected Member Functions inherited from RV_ShaderProgramBase
static RV_VKPipelineLayoutPtr	loadShaderProgram (RV_Instance inst, const char program, const char *extra_defines=nullptr)

Detailed Description

Compute shader object.

Definition at line 373 of file RV_ShaderProgram.h.

Constructor & Destructor Documentation

RV_ShaderCompute::~RV_ShaderCompute ( )

override

RV_ShaderCompute::RV_ShaderCompute	(	RV_Instance *	inst,
		RV_VKPipelineLayoutPtr	pipe_layout,
		RV_VKPipelinePtr	pipeline
	)

protected

Member Function Documentation

static RV_ShaderCompute* RV_ShaderCompute::createShaderProgram	(	RV_Instance *	inst,
		RV_VKShader &	shader
	)

static

Create Shader using GLSL to SPIR-V compiler object.

static RV_ShaderCompute* RV_ShaderCompute::createShaderProgram	(	RV_Instance *	inst,
		const UT_StringArray &	filenames
	)

static

Create Shader using list of SPIR-V binary filenames.

static RV_ShaderCompute* RV_ShaderCompute::createShaderProgram	(	RV_Instance *	inst,
		UT_Array< RV_VKShaderModuleInfoPtr > &	rv_modules
	)

static

Create Shader using list of SPIR-V modules.

static RV_ShaderCompute* RV_ShaderCompute::createShaderProgram	(	RV_Instance *	inst,
		RV_VKPipelineLayoutPtr	layout
	)

static

RV_ShaderType RV_ShaderCompute::getShaderType ( ) const

inlineoverridevirtual

Type of shader - graphics or compute.

Implements RV_ShaderProgramBase.

Definition at line 404 of file RV_ShaderProgram.h.

const UT_Vector3i& RV_ShaderCompute::getWorkGroupSize ( ) const

inline

Definition at line 409 of file RV_ShaderProgram.h.

bool RV_ShaderCompute::hasWorkGroupSpecializationConst ( ) const

inline

Definition at line 412 of file RV_ShaderProgram.h.

static RV_ShaderCompute* RV_ShaderCompute::loadShaderProgram	(	RV_Instance *	inst,
		const char *	program,
		const char *	extra_defines = `nullptr`
	)

static

or compiling if no spir-v found, and sources have been copied to hfs NOTE: providing extra defines forces compilation

bool RV_ShaderCompute::prepareForDraw	(	RV_Instance *	inst,
		RV_VKCommandBuffer *	cb
	)

void RV_ShaderCompute::print ( ) const

overridevirtual

Debug print message.

Reimplemented from RV_ShaderProgramBase.

Member Data Documentation

UT_UniquePtr<RV_VKPipeline> RV_ShaderCompute::myPipeline

protected

Definition at line 429 of file RV_ShaderProgram.h.

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

RV/RV_ShaderProgram.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation