#include "pxr/pxr.h"
#include "pxr/imaging/hgi/api.h"
#include "pxr/imaging/hgi/enums.h"
#include "pxr/imaging/hgi/types.h"
#include <string>
#include <vector>

Include dependency graph for shaderFunctionDesc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	HgiShaderFunctionTextureDesc

struct	HgiShaderFunctionBufferDesc

struct	HgiShaderFunctionParamDesc

struct	HgiShaderFunctionParamBlockDesc

struct	HgiShaderFunctionParamBlockDesc::Member

struct	HgiShaderFunctionComputeDesc

struct	HgiShaderFunctionTessellationDesc

struct	HgiShaderFunctionGeometryDesc

struct	HgiShaderFunctionFragmentDesc

struct	HgiShaderFunctionDesc

Typedefs
using	HgiShaderFunctionTextureDescVector = std::vector< HgiShaderFunctionTextureDesc >

using	HgiShaderFunctionBufferDescVector = std::vector< HgiShaderFunctionBufferDesc >

using	HgiShaderFunctionParamDescVector = std::vector< HgiShaderFunctionParamDesc >

using	HgiShaderFunctionParamBlockDescVector = std::vector< HgiShaderFunctionParamBlockDesc >

using	HgiShaderFunctionDescVector = std::vector< HgiShaderFunctionDesc >

Functions
HGI_API bool	operator== (const HgiShaderFunctionTextureDesc &lhs, const HgiShaderFunctionTextureDesc &rhs)

HGI_API bool	operator!= (const HgiShaderFunctionTextureDesc &lhs, const HgiShaderFunctionTextureDesc &rhs)

HGI_API bool	operator== (const HgiShaderFunctionBufferDesc &lhs, const HgiShaderFunctionBufferDesc &rhs)

HGI_API bool	operator!= (const HgiShaderFunctionBufferDesc &lhs, const HgiShaderFunctionBufferDesc &rhs)

HGI_API bool	operator== (const HgiShaderFunctionParamDesc &lhs, const HgiShaderFunctionParamDesc &rhs)

HGI_API bool	operator!= (const HgiShaderFunctionParamDesc &lhs, const HgiShaderFunctionParamDesc &rhs)

HGI_API bool	operator== (const HgiShaderFunctionParamBlockDesc &lhs, const HgiShaderFunctionParamBlockDesc &rhs)

HGI_API bool	operator!= (const HgiShaderFunctionParamBlockDesc &lhs, const HgiShaderFunctionParamBlockDesc &rhs)

HGI_API bool	operator== (const HgiShaderFunctionParamBlockDesc::Member &lhs, const HgiShaderFunctionParamBlockDesc::Member &rhs)

HGI_API bool	operator!= (const HgiShaderFunctionParamBlockDesc::Member &lhs, const HgiShaderFunctionParamBlockDesc::Member &rhs)

HGI_API bool	operator== (const HgiShaderFunctionComputeDesc &lhs, const HgiShaderFunctionComputeDesc &rhs)

HGI_API bool	operator!= (const HgiShaderFunctionComputeDesc &lhs, const HgiShaderFunctionComputeDesc &rhs)

HGI_API bool	operator== (const HgiShaderFunctionTessellationDesc &lhs, const HgiShaderFunctionTessellationDesc &rhs)

HGI_API bool	operator!= (const HgiShaderFunctionTessellationDesc &lhs, const HgiShaderFunctionTessellationDesc &rhs)

HGI_API bool	operator== (const HgiShaderFunctionGeometryDesc &lhs, const HgiShaderFunctionGeometryDesc &rhs)

HGI_API bool	operator!= (const HgiShaderFunctionGeometryDesc &lhs, const HgiShaderFunctionGeometryDesc &rhs)

HGI_API bool	operator== (const HgiShaderFunctionFragmentDesc &lhs, const HgiShaderFunctionFragmentDesc &rhs)

HGI_API bool	operator!= (const HgiShaderFunctionFragmentDesc &lhs, const HgiShaderFunctionFragmentDesc &rhs)

HGI_API bool	operator== (const HgiShaderFunctionDesc &lhs, const HgiShaderFunctionDesc &rhs)

HGI_API bool	operator!= (const HgiShaderFunctionDesc &lhs, const HgiShaderFunctionDesc &rhs)

HGI_API void	HgiShaderFunctionAddTexture (HgiShaderFunctionDesc *desc, const std::string &nameInShader, const uint32_t bindIndex=0, uint32_t dimensions=2, const HgiFormat &format=HgiFormatFloat32Vec4, const HgiShaderTextureType textureType=HgiShaderTextureTypeTexture)
	Adds texture descriptor to given shader function descriptor. More...

HGI_API void	HgiShaderFunctionAddArrayOfTextures (HgiShaderFunctionDesc *desc, const std::string &nameInShader, const uint32_t arraySize, const uint32_t bindIndex=0, const uint32_t dimensions=2, const HgiFormat &format=HgiFormatFloat32Vec4, const HgiShaderTextureType textureType=HgiShaderTextureTypeTexture)
	Adds array of textures descriptor to given shader function descriptor. More...

HGI_API void	HgiShaderFunctionAddWritableTexture (HgiShaderFunctionDesc *desc, const std::string &nameInShader, const uint32_t bindIndex=0, const uint32_t dimensions=2, const HgiFormat &format=HgiFormatFloat32Vec4, const HgiShaderTextureType textureType=HgiShaderTextureTypeTexture)
	Adds writable texture descriptor to given shader function descriptor. More...

HGI_API void	HgiShaderFunctionAddBuffer (HgiShaderFunctionDesc *desc, const std::string &nameInShader, const std::string &type, const uint32_t bindIndex, HgiBindingType binding, const uint32_t arraySize=0)
	Adds buffer descriptor to given shader function descriptor. More...

HGI_API void	HgiShaderFunctionAddWritableBuffer (HgiShaderFunctionDesc *desc, const std::string &nameInShader, const std::string &type, const uint32_t bindIndex)
	Adds buffer descriptor to given shader function descriptor. More...

HGI_API void	HgiShaderFunctionAddConstantParam (HgiShaderFunctionDesc *desc, const std::string &nameInShader, const std::string &type, const std::string &role=std::string())

HGI_API void	HgiShaderFunctionAddStageInput (HgiShaderFunctionDesc *desc, const std::string &nameInShader, const std::string &type, const std::string &role=std::string())

HGI_API void	HgiShaderFunctionAddStageInput (HgiShaderFunctionDesc *functionDesc, HgiShaderFunctionParamDesc const &paramDesc)

HGI_API void	HgiShaderFunctionAddGlobalVariable (HgiShaderFunctionDesc *desc, const std::string &nameInShader, const std::string &type, const std::string &arraySize)
	Interstage input. More...

HGI_API void	HgiShaderFunctionAddStageOutput (HgiShaderFunctionDesc *desc, const std::string &nameInShader, const std::string &type, const std::string &role=std::string(), const std::string &arraySize=std::string())

HGI_API void	HgiShaderFunctionAddStageOutput (HgiShaderFunctionDesc *desc, const std::string &nameInShader, const std::string &type, const uint32_t location)

HGI_API void	HgiShaderFunctionAddStageOutput (HgiShaderFunctionDesc *functionDesc, HgiShaderFunctionParamDesc const &paramDesc)

Typedef Documentation

using HgiShaderFunctionBufferDescVector = std::vector<HgiShaderFunctionBufferDesc>

Definition at line 125 of file shaderFunctionDesc.h.

using HgiShaderFunctionDescVector = std::vector<HgiShaderFunctionDesc>

Definition at line 461 of file shaderFunctionDesc.h.

using HgiShaderFunctionParamBlockDescVector = std::vector<HgiShaderFunctionParamBlockDesc>

Definition at line 229 of file shaderFunctionDesc.h.

using HgiShaderFunctionParamDescVector = std::vector<HgiShaderFunctionParamDesc>

Definition at line 180 of file shaderFunctionDesc.h.

using HgiShaderFunctionTextureDescVector = std::vector<HgiShaderFunctionTextureDesc>

Definition at line 80 of file shaderFunctionDesc.h.

Function Documentation

HGI_API void HgiShaderFunctionAddArrayOfTextures	(	HgiShaderFunctionDesc *	desc,
		const std::string &	nameInShader,
		const uint32_t	arraySize,
		const uint32_t	bindIndex = `0`,
		const uint32_t	dimensions = `2`,
		const HgiFormat &	format = `HgiFormatFloat32Vec4`,
		const HgiShaderTextureType	textureType = `HgiShaderTextureTypeTexture`
	)

Adds array of textures descriptor to given shader function descriptor.

HGI_API void HgiShaderFunctionAddBuffer	(	HgiShaderFunctionDesc *	desc,
		const std::string &	nameInShader,
		const std::string &	type,
		const uint32_t	bindIndex,
		HgiBindingType	binding,
		const uint32_t	arraySize = `0`
	)

Adds buffer descriptor to given shader function descriptor.

HGI_API void HgiShaderFunctionAddConstantParam	(	HgiShaderFunctionDesc *	desc,
		const std::string &	nameInShader,
		const std::string &	type,
		const std::string &	role = `std::string()`
	)

Adds constant function param descriptor to given shader function descriptor.

HGI_API void HgiShaderFunctionAddGlobalVariable	(	HgiShaderFunctionDesc *	desc,
		const std::string &	nameInShader,
		const std::string &	type,
		const std::string &	arraySize
	)

Interstage input.

HGI_API void HgiShaderFunctionAddStageInput	(	HgiShaderFunctionDesc *	desc,
		const std::string &	nameInShader,
		const std::string &	type,
		const std::string &	role = `std::string()`
	)

Adds stage input function param descriptor to given shader function descriptor. The location is will be set to the next available.

HGI_API void HgiShaderFunctionAddStageInput	(	HgiShaderFunctionDesc *	functionDesc,
		HgiShaderFunctionParamDesc const &	paramDesc
	)

Adds stage input function param descriptor to given shader function descriptor given param descriptor.

HGI_API void HgiShaderFunctionAddStageOutput	(	HgiShaderFunctionDesc *	desc,
		const std::string &	nameInShader,
		const std::string &	type,
		const std::string &	role = `std::string()`,
		const std::string &	arraySize = `std::string()`
	)

Adds stage output function param descriptor to given shader function descriptor.

HGI_API void HgiShaderFunctionAddStageOutput	(	HgiShaderFunctionDesc *	desc,
		const std::string &	nameInShader,
		const std::string &	type,
		const uint32_t	location
	)

Adds stage output function param descriptor to given shader function descriptor.

HGI_API void HgiShaderFunctionAddStageOutput	(	HgiShaderFunctionDesc *	functionDesc,
		HgiShaderFunctionParamDesc const &	paramDesc
	)

Adds stage output function param descriptor to given shader function descriptor given param descriptor.

HGI_API void HgiShaderFunctionAddTexture	(	HgiShaderFunctionDesc *	desc,
		const std::string &	nameInShader,
		const uint32_t	bindIndex = `0`,
		uint32_t	dimensions = `2`,
		const HgiFormat &	format = `HgiFormatFloat32Vec4`,
		const HgiShaderTextureType	textureType = `HgiShaderTextureTypeTexture`
	)

Adds texture descriptor to given shader function descriptor.

HGI_API void HgiShaderFunctionAddWritableBuffer	(	HgiShaderFunctionDesc *	desc,
		const std::string &	nameInShader,
		const std::string &	type,
		const uint32_t	bindIndex
	)

Adds buffer descriptor to given shader function descriptor.

HGI_API void HgiShaderFunctionAddWritableTexture	(	HgiShaderFunctionDesc *	desc,
		const std::string &	nameInShader,
		const uint32_t	bindIndex = `0`,
		const uint32_t	dimensions = `2`,
		const HgiFormat &	format = `HgiFormatFloat32Vec4`,
		const HgiShaderTextureType	textureType = `HgiShaderTextureTypeTexture`
	)

Adds writable texture descriptor to given shader function descriptor.

HGI_API bool operator!=	(	const HgiShaderFunctionTextureDesc &	lhs,
		const HgiShaderFunctionTextureDesc &	rhs
	)

HGI_API bool operator!=	(	const HgiShaderFunctionBufferDesc &	lhs,
		const HgiShaderFunctionBufferDesc &	rhs
	)

HGI_API bool operator!=	(	const HgiShaderFunctionParamDesc &	lhs,
		const HgiShaderFunctionParamDesc &	rhs
	)

HGI_API bool operator!=	(	const HgiShaderFunctionParamBlockDesc &	lhs,
		const HgiShaderFunctionParamBlockDesc &	rhs
	)

HGI_API bool operator!=	(	const HgiShaderFunctionParamBlockDesc::Member &	lhs,
		const HgiShaderFunctionParamBlockDesc::Member &	rhs
	)

HGI_API bool operator!=	(	const HgiShaderFunctionComputeDesc &	lhs,
		const HgiShaderFunctionComputeDesc &	rhs
	)

HGI_API bool operator!=	(	const HgiShaderFunctionTessellationDesc &	lhs,
		const HgiShaderFunctionTessellationDesc &	rhs
	)

HGI_API bool operator!=	(	const HgiShaderFunctionGeometryDesc &	lhs,
		const HgiShaderFunctionGeometryDesc &	rhs
	)

HGI_API bool operator!=	(	const HgiShaderFunctionFragmentDesc &	lhs,
		const HgiShaderFunctionFragmentDesc &	rhs
	)

HGI_API bool operator!=	(	const HgiShaderFunctionDesc &	lhs,
		const HgiShaderFunctionDesc &	rhs
	)

HGI_API bool operator==	(	const HgiShaderFunctionTextureDesc &	lhs,
		const HgiShaderFunctionTextureDesc &	rhs
	)

HGI_API bool operator==	(	const HgiShaderFunctionBufferDesc &	lhs,
		const HgiShaderFunctionBufferDesc &	rhs
	)

HGI_API bool operator==	(	const HgiShaderFunctionParamDesc &	lhs,
		const HgiShaderFunctionParamDesc &	rhs
	)

HGI_API bool operator==	(	const HgiShaderFunctionParamBlockDesc &	lhs,
		const HgiShaderFunctionParamBlockDesc &	rhs
	)

HGI_API bool operator==	(	const HgiShaderFunctionParamBlockDesc::Member &	lhs,
		const HgiShaderFunctionParamBlockDesc::Member &	rhs
	)

HGI_API bool operator==	(	const HgiShaderFunctionComputeDesc &	lhs,
		const HgiShaderFunctionComputeDesc &	rhs
	)

HGI_API bool operator==	(	const HgiShaderFunctionTessellationDesc &	lhs,
		const HgiShaderFunctionTessellationDesc &	rhs
	)

HGI_API bool operator==	(	const HgiShaderFunctionGeometryDesc &	lhs,
		const HgiShaderFunctionGeometryDesc &	rhs
	)

HGI_API bool operator==	(	const HgiShaderFunctionFragmentDesc &	lhs,
		const HgiShaderFunctionFragmentDesc &	rhs
	)

HGI_API bool operator==	(	const HgiShaderFunctionDesc &	lhs,
		const HgiShaderFunctionDesc &	rhs
	)

Classes

Typedefs

Functions

Typedef Documentation

Function Documentation