Interface making it possible to create and use programs running on the GPU. More...

#include <duckcpp/core/engine/IGPUProgrammingServices.hpp>

Public Member Functions
virtual	~IGPUProgrammingServices ()
	Destructor.

virtual dcpp::int32_kt	addHighLevelShaderMaterial (const dcpp::char_kt vertexShaderProgram, const dcpp::char_kt vertexShaderEntryPointName, E_VERTEX_SHADER_TYPE vsCompileTarget, const dcpp::char_kt pixelShaderProgram, const dcpp::char_kt pixelShaderEntryPointName, E_PIXEL_SHADER_TYPE psCompileTarget, const dcpp::char_kt geometryShaderProgram, const dcpp::char_kt geometryShaderEntryPointName="main", E_GEOMETRY_SHADER_TYPE gsCompileTarget=EGST_GS_4_0, dcpp::scene::E_PRIMITIVE_TYPE inType=dcpp::scene::EPT_TRIANGLES, dcpp::scene::E_PRIMITIVE_TYPE outType=dcpp::scene::EPT_TRIANGLE_STRIP, dcpp::uint32_kt verticesOut=0, IShaderConstantSetCallBack *callback=0, E_MATERIAL_TYPE baseMaterial=dcpp::video::EMT_SOLID, dcpp::int32_kt userData=0)=0
	Adds a new high-level shading material renderer to the VideoDriver.

dcpp::int32_kt	addHighLevelShaderMaterial (const dcpp::char_kt vertexShaderProgram, const dcpp::char_kt vertexShaderEntryPointName="main", E_VERTEX_SHADER_TYPE vsCompileTarget=EVST_VS_1_1, const dcpp::char_kt pixelShaderProgram=0, const dcpp::char_kt pixelShaderEntryPointName="main", E_PIXEL_SHADER_TYPE psCompileTarget=EPST_PS_1_1, IShaderConstantSetCallBack *callback=0, E_MATERIAL_TYPE baseMaterial=dcpp::video::EMT_SOLID, dcpp::int32_kt userData=0)
	convenience function for use without geometry shaders

dcpp::int32_kt	addHighLevelShaderMaterial (const dcpp::char_kt vertexShaderProgram, const dcpp::char_kt pixelShaderProgram=0, IShaderConstantSetCallBack *callback=0, E_MATERIAL_TYPE baseMaterial=dcpp::video::EMT_SOLID, dcpp::int32_kt userData=0)
	convenience function for use with many defaults, without geometry shader

dcpp::int32_kt	addHighLevelShaderMaterial (const dcpp::char_kt vertexShaderProgram, const dcpp::char_kt pixelShaderProgram=0, const dcpp::char_kt geometryShaderProgram=0, dcpp::scene::E_PRIMITIVE_TYPE inType=dcpp::scene::EPT_TRIANGLES, dcpp::scene::E_PRIMITIVE_TYPE outType=dcpp::scene::EPT_TRIANGLE_STRIP, dcpp::uint32_kt verticesOut=0, IShaderConstantSetCallBack callback=0, E_MATERIAL_TYPE baseMaterial=dcpp::video::EMT_SOLID, dcpp::int32_kt userData=0)
	convenience function for use with many defaults, with geometry shader

virtual dcpp::int32_kt	addHighLevelShaderMaterialFromFiles (const dcpp::io::path &vertexShaderProgramFileName, const dcpp::char_kt vertexShaderEntryPointName, E_VERTEX_SHADER_TYPE vsCompileTarget, const dcpp::io::path &pixelShaderProgramFileName, const dcpp::char_kt pixelShaderEntryPointName, E_PIXEL_SHADER_TYPE psCompileTarget, const dcpp::io::path &geometryShaderProgramFileName, const dcpp::char_kt geometryShaderEntryPointName="main", E_GEOMETRY_SHADER_TYPE gsCompileTarget=EGST_GS_4_0, dcpp::scene::E_PRIMITIVE_TYPE inType=dcpp::scene::EPT_TRIANGLES, dcpp::scene::E_PRIMITIVE_TYPE outType=dcpp::scene::EPT_TRIANGLE_STRIP, dcpp::uint32_kt verticesOut=0, IShaderConstantSetCallBack callback=0, E_MATERIAL_TYPE baseMaterial=dcpp::video::EMT_SOLID, dcpp::int32_kt userData=0)=0
	Like IGPUProgrammingServices::addShaderMaterial(), but loads from files.

dcpp::int32_kt	addHighLevelShaderMaterialFromFiles (const dcpp::io::path &vertexShaderProgramFileName, const dcpp::char_kt vertexShaderEntryPointName="main", E_VERTEX_SHADER_TYPE vsCompileTarget=EVST_VS_1_1, const dcpp::io::path &pixelShaderProgramFileName="", const dcpp::char_kt pixelShaderEntryPointName="main", E_PIXEL_SHADER_TYPE psCompileTarget=EPST_PS_1_1, IShaderConstantSetCallBack *callback=0, E_MATERIAL_TYPE baseMaterial=dcpp::video::EMT_SOLID, dcpp::int32_kt userData=0)
	convenience function for use without geometry shaders

dcpp::int32_kt	addHighLevelShaderMaterialFromFiles (const dcpp::io::path &vertexShaderProgramFileName, const dcpp::io::path &pixelShaderProgramFileName="", IShaderConstantSetCallBack *callback=0, E_MATERIAL_TYPE baseMaterial=dcpp::video::EMT_SOLID, dcpp::int32_kt userData=0)
	convenience function for use with many defaults, without geometry shader

dcpp::int32_kt	addHighLevelShaderMaterialFromFiles (const dcpp::io::path &vertexShaderProgramFileName, const dcpp::io::path &pixelShaderProgramFileName="", const dcpp::io::path &geometryShaderProgramFileName="", dcpp::scene::E_PRIMITIVE_TYPE inType=dcpp::scene::EPT_TRIANGLES, dcpp::scene::E_PRIMITIVE_TYPE outType=dcpp::scene::EPT_TRIANGLE_STRIP, dcpp::uint32_kt verticesOut=0, IShaderConstantSetCallBack *callback=0, E_MATERIAL_TYPE baseMaterial=dcpp::video::EMT_SOLID, dcpp::int32_kt userData=0)
	convenience function for use with many defaults, with geometry shader

virtual dcpp::int32_kt	addHighLevelShaderMaterialFromFiles (dcpp::io::IReadFile vertexShaderProgram, const dcpp::char_kt vertexShaderEntryPointName, E_VERTEX_SHADER_TYPE vsCompileTarget, dcpp::io::IReadFile pixelShaderProgram, const dcpp::char_kt pixelShaderEntryPointName, E_PIXEL_SHADER_TYPE psCompileTarget, dcpp::io::IReadFile geometryShaderProgram, const dcpp::char_kt geometryShaderEntryPointName="main", E_GEOMETRY_SHADER_TYPE gsCompileTarget=EGST_GS_4_0, dcpp::scene::E_PRIMITIVE_TYPE inType=dcpp::scene::EPT_TRIANGLES, dcpp::scene::E_PRIMITIVE_TYPE outType=dcpp::scene::EPT_TRIANGLE_STRIP, dcpp::uint32_kt verticesOut=0, IShaderConstantSetCallBack *callback=0, E_MATERIAL_TYPE baseMaterial=dcpp::video::EMT_SOLID, dcpp::int32_kt userData=0)=0
	Like IGPUProgrammingServices::addShaderMaterial(), but loads from files.

dcpp::int32_kt	addHighLevelShaderMaterialFromFiles (dcpp::io::IReadFile vertexShaderProgram, const dcpp::char_kt vertexShaderEntryPointName="main", E_VERTEX_SHADER_TYPE vsCompileTarget=EVST_VS_1_1, dcpp::io::IReadFile pixelShaderProgram=0, const dcpp::char_kt pixelShaderEntryPointName="main", E_PIXEL_SHADER_TYPE psCompileTarget=EPST_PS_1_1, IShaderConstantSetCallBack *callback=0, E_MATERIAL_TYPE baseMaterial=dcpp::video::EMT_SOLID, dcpp::int32_kt userData=0)
	convenience function for use without geometry shaders

virtual dcpp::int32_kt	addShaderMaterial (const dcpp::char_kt vertexShaderProgram=0, const dcpp::char_kt pixelShaderProgram=0, IShaderConstantSetCallBack *callback=0, E_MATERIAL_TYPE baseMaterial=dcpp::video::EMT_SOLID, dcpp::int32_kt userData=0)=0
	Adds a new ASM shader material renderer to the VideoDriver.

virtual dcpp::int32_kt	addShaderMaterialFromFiles (dcpp::io::IReadFile vertexShaderProgram, dcpp::io::IReadFile pixelShaderProgram, IShaderConstantSetCallBack *callback=0, E_MATERIAL_TYPE baseMaterial=dcpp::video::EMT_SOLID, dcpp::int32_kt userData=0)=0
	Like IGPUProgrammingServices::addShaderMaterial(), but loads from files.

virtual dcpp::int32_kt	addShaderMaterialFromFiles (const dcpp::io::path &vertexShaderProgramFileName, const dcpp::io::path &pixelShaderProgramFileName, IShaderConstantSetCallBack *callback=0, E_MATERIAL_TYPE baseMaterial=dcpp::video::EMT_SOLID, dcpp::int32_kt userData=0)=0
	Like IGPUProgrammingServices::addShaderMaterial(), but loads from files.

Detailed Description

Interface making it possible to create and use programs running on the GPU.

Member Function Documentation

◆ addHighLevelShaderMaterial() [1/3]

dcpp::int32_kt dcpp::video::IGPUProgrammingServices::addHighLevelShaderMaterial	(	const dcpp::char_kt *	vertexShaderProgram,
		const dcpp::char_kt *	pixelShaderProgram = `0`,
		const dcpp::char_kt *	geometryShaderProgram = `0`,
		dcpp::scene::E_PRIMITIVE_TYPE	inType = `dcpp::scene::EPT_TRIANGLES`,
		dcpp::scene::E_PRIMITIVE_TYPE	outType = `dcpp::scene::EPT_TRIANGLE_STRIP`,
		dcpp::uint32_kt	verticesOut = `0`,
		IShaderConstantSetCallBack *	callback = `0`,
		E_MATERIAL_TYPE	baseMaterial = `dcpp::video::EMT_SOLID`,
		dcpp::int32_kt	userData = `0`
	)

inline

convenience function for use with many defaults, with geometry shader

All shader names are set to "main" and compile targets are shader type 1.1 and geometry shader 4.0.

◆ addHighLevelShaderMaterial() [2/3]

dcpp::int32_kt dcpp::video::IGPUProgrammingServices::addHighLevelShaderMaterial	(	const dcpp::char_kt *	vertexShaderProgram,
		const dcpp::char_kt *	pixelShaderProgram = `0`,
		IShaderConstantSetCallBack *	callback = `0`,
		E_MATERIAL_TYPE	baseMaterial = `dcpp::video::EMT_SOLID`,
		dcpp::int32_kt	userData = `0`
	)

inline

convenience function for use with many defaults, without geometry shader

All shader names are set to "main" and compile targets are shader type 1.1.

◆ addHighLevelShaderMaterial() [3/3]

virtual dcpp::int32_kt dcpp::video::IGPUProgrammingServices::addHighLevelShaderMaterial	(	const dcpp::char_kt *	vertexShaderProgram,
		const dcpp::char_kt *	vertexShaderEntryPointName,
		E_VERTEX_SHADER_TYPE	vsCompileTarget,
		const dcpp::char_kt *	pixelShaderProgram,
		const dcpp::char_kt *	pixelShaderEntryPointName,
		E_PIXEL_SHADER_TYPE	psCompileTarget,
		const dcpp::char_kt *	geometryShaderProgram,
		const dcpp::char_kt *	geometryShaderEntryPointName = `"main"`,
		E_GEOMETRY_SHADER_TYPE	gsCompileTarget = `EGST_GS_4_0`,
		dcpp::scene::E_PRIMITIVE_TYPE	inType = `dcpp::scene::EPT_TRIANGLES`,
		dcpp::scene::E_PRIMITIVE_TYPE	outType = `dcpp::scene::EPT_TRIANGLE_STRIP`,
		dcpp::uint32_kt	verticesOut = `0`,
		IShaderConstantSetCallBack *	callback = `0`,
		E_MATERIAL_TYPE	baseMaterial = `dcpp::video::EMT_SOLID`,
		dcpp::int32_kt	userData = `0`
	)

pure virtual

Adds a new high-level shading material renderer to the VideoDriver.

Currently only HLSL/D3D9 and GLSL/OpenGL are supported.

Parameters

vertexShaderProgram	String containing the source of the vertex shader program. This can be 0 if no vertex program shall be used.
vertexShaderEntryPointName	Name of the entry function of the vertexShaderProgram (p.e. "main")
vsCompileTarget	Vertex shader version the high level shader shall be compiled to.
pixelShaderProgram	String containing the source of the pixel shader program. This can be 0 if no pixel shader shall be used.
pixelShaderEntryPointName	Entry name of the function of the pixelShaderProgram (p.e. "main")
psCompileTarget	Pixel shader version the high level shader shall be compiled to.
geometryShaderProgram	String containing the source of the geometry shader program. This can be 0 if no geometry shader shall be used.
geometryShaderEntryPointName	Entry name of the function of the geometryShaderProgram (p.e. "main")
gsCompileTarget	Geometry shader version the high level shader shall be compiled to.
inType	Type of vertices passed to geometry shader
outType	Type of vertices created by geometry shader
verticesOut	Maximal number of vertices created by geometry shader. If 0, maximal number supported is assumed.
callback	Pointer to an implementation of IShaderConstantSetCallBack in which you can set the needed vertex, pixel, and geometry shader program constants. Set this to 0 if you don't need this.
baseMaterial	Base material which renderstates will be used to shade the material.
userData	a user data int. This int can be set to any value and will be set as parameter in the callback method when calling OnSetConstants(). In this way it is easily possible to use the same callback method for multiple materials and distinguish between them during the call.

Returns: Number of the material type which can be set in SMaterial::MaterialType to use the renderer. -1 is returned if an error occurred, e.g. if a shader program could not be compiled or a compile target is not reachable. The error strings are then printed to the error log and can be caught with a custom event receiver.

◆ addHighLevelShaderMaterialFromFiles() [1/4]

virtual dcpp::int32_kt dcpp::video::IGPUProgrammingServices::addHighLevelShaderMaterialFromFiles	(	const dcpp::io::path &	vertexShaderProgramFileName,
		const dcpp::char_kt *	vertexShaderEntryPointName,
		E_VERTEX_SHADER_TYPE	vsCompileTarget,
		const dcpp::io::path &	pixelShaderProgramFileName,
		const dcpp::char_kt *	pixelShaderEntryPointName,
		E_PIXEL_SHADER_TYPE	psCompileTarget,
		const dcpp::io::path &	geometryShaderProgramFileName,
		const dcpp::char_kt *	geometryShaderEntryPointName = `"main"`,
		E_GEOMETRY_SHADER_TYPE	gsCompileTarget = `EGST_GS_4_0`,
		dcpp::scene::E_PRIMITIVE_TYPE	inType = `dcpp::scene::EPT_TRIANGLES`,
		dcpp::scene::E_PRIMITIVE_TYPE	outType = `dcpp::scene::EPT_TRIANGLE_STRIP`,
		dcpp::uint32_kt	verticesOut = `0`,
		IShaderConstantSetCallBack *	callback = `0`,
		E_MATERIAL_TYPE	baseMaterial = `dcpp::video::EMT_SOLID`,
		dcpp::int32_kt	userData = `0`
	)

pure virtual

Like IGPUProgrammingServices::addShaderMaterial(), but loads from files.

Parameters

vertexShaderProgramFileName	Text file containing the source of the vertex shader program. Set to empty string if no vertex shader shall be created.
vertexShaderEntryPointName	Name of the entry function of the vertexShaderProgram (p.e. "main")
vsCompileTarget	Vertex shader version the high level shader shall be compiled to.
pixelShaderProgramFileName	Text file containing the source of the pixel shader program. Set to empty string if no pixel shader shall be created.
pixelShaderEntryPointName	Entry name of the function of the pixelShaderProgram (p.e. "main")
psCompileTarget	Pixel shader version the high level shader shall be compiled to.
geometryShaderProgramFileName	Name of the source of the geometry shader program. Set to empty string if no geometry shader shall be created.
geometryShaderEntryPointName	Entry name of the function of the geometryShaderProgram (p.e. "main")
gsCompileTarget	Geometry shader version the high level shader shall be compiled to.
inType	Type of vertices passed to geometry shader
outType	Type of vertices created by geometry shader
verticesOut	Maximal number of vertices created by geometry shader. If 0, maximal number supported is assumed.
callback	Pointer to an implementation of IShaderConstantSetCallBack in which you can set the needed vertex, pixel, and geometry shader program constants. Set this to 0 if you don't need this.
baseMaterial	Base material which renderstates will be used to shade the material.
userData	a user data int. This int can be set to any value and will be set as parameter in the callback method when calling OnSetConstants(). In this way it is easily possible to use the same callback method for multiple materials and distinguish between them during the call.

Returns: Number of the material type which can be set in SMaterial::MaterialType to use the renderer. -1 is returned if an error occurred, e.g. if a shader program could not be compiled or a compile target is not reachable. The error strings are then printed to the error log and can be caught with a custom event receiver.

◆ addHighLevelShaderMaterialFromFiles() [2/4]

dcpp::int32_kt dcpp::video::IGPUProgrammingServices::addHighLevelShaderMaterialFromFiles	(	const dcpp::io::path &	vertexShaderProgramFileName,
		const dcpp::io::path &	pixelShaderProgramFileName = `""`,
		const dcpp::io::path &	geometryShaderProgramFileName = `""`,
		dcpp::scene::E_PRIMITIVE_TYPE	inType = `dcpp::scene::EPT_TRIANGLES`,
		dcpp::scene::E_PRIMITIVE_TYPE	outType = `dcpp::scene::EPT_TRIANGLE_STRIP`,
		dcpp::uint32_kt	verticesOut = `0`,
		IShaderConstantSetCallBack *	callback = `0`,
		E_MATERIAL_TYPE	baseMaterial = `dcpp::video::EMT_SOLID`,
		dcpp::int32_kt	userData = `0`
	)

inline

convenience function for use with many defaults, with geometry shader

All shader names are set to "main" and compile targets are shader type 1.1 and geometry shader 4.0.

◆ addHighLevelShaderMaterialFromFiles() [3/4]

dcpp::int32_kt dcpp::video::IGPUProgrammingServices::addHighLevelShaderMaterialFromFiles	(	const dcpp::io::path &	vertexShaderProgramFileName,
		const dcpp::io::path &	pixelShaderProgramFileName = `""`,
		IShaderConstantSetCallBack *	callback = `0`,
		E_MATERIAL_TYPE	baseMaterial = `dcpp::video::EMT_SOLID`,
		dcpp::int32_kt	userData = `0`
	)

inline

convenience function for use with many defaults, without geometry shader

All shader names are set to "main" and compile targets are shader type 1.1.

◆ addHighLevelShaderMaterialFromFiles() [4/4]

virtual dcpp::int32_kt dcpp::video::IGPUProgrammingServices::addHighLevelShaderMaterialFromFiles	(	dcpp::io::IReadFile *	vertexShaderProgram,
		const dcpp::char_kt *	vertexShaderEntryPointName,
		E_VERTEX_SHADER_TYPE	vsCompileTarget,
		dcpp::io::IReadFile *	pixelShaderProgram,
		const dcpp::char_kt *	pixelShaderEntryPointName,
		E_PIXEL_SHADER_TYPE	psCompileTarget,
		dcpp::io::IReadFile *	geometryShaderProgram,
		const dcpp::char_kt *	geometryShaderEntryPointName = `"main"`,
		E_GEOMETRY_SHADER_TYPE	gsCompileTarget = `EGST_GS_4_0`,
		dcpp::scene::E_PRIMITIVE_TYPE	inType = `dcpp::scene::EPT_TRIANGLES`,
		dcpp::scene::E_PRIMITIVE_TYPE	outType = `dcpp::scene::EPT_TRIANGLE_STRIP`,
		dcpp::uint32_kt	verticesOut = `0`,
		IShaderConstantSetCallBack *	callback = `0`,
		E_MATERIAL_TYPE	baseMaterial = `dcpp::video::EMT_SOLID`,
		dcpp::int32_kt	userData = `0`
	)

pure virtual

Like IGPUProgrammingServices::addShaderMaterial(), but loads from files.

Parameters

vertexShaderProgram	Text file handle containing the source of the vertex shader program. Set to 0 if no vertex shader shall be created.
vertexShaderEntryPointName	Name of the entry function of the vertexShaderProgram
vsCompileTarget	Vertex shader version the high level shader shall be compiled to.
pixelShaderProgram	Text file handle containing the source of the pixel shader program. Set to 0 if no pixel shader shall be created.
pixelShaderEntryPointName	Entry name of the function of the pixelShaderProgram (p.e. "main")
psCompileTarget	Pixel shader version the high level shader shall be compiled to.
geometryShaderProgram	Text file handle containing the source of the geometry shader program. Set to 0 if no geometry shader shall be created.
geometryShaderEntryPointName	Entry name of the function of the geometryShaderProgram (p.e. "main")
gsCompileTarget	Geometry shader version the high level shader shall be compiled to.
inType	Type of vertices passed to geometry shader
outType	Type of vertices created by geometry shader
verticesOut	Maximal number of vertices created by geometry shader. If 0, maximal number supported is assumed.
callback	Pointer to an implementation of IShaderConstantSetCallBack in which you can set the needed vertex and pixel shader program constants. Set this to 0 if you don't need this.
baseMaterial	Base material which renderstates will be used to shade the material.
userData	a user data int. This int can be set to any value and will be set as parameter in the callback method when calling OnSetConstants(). In this way it is easily possible to use the same callback method for multiple materials and distinguish between them during the call.

Returns: Number of the material type which can be set in SMaterial::MaterialType to use the renderer. -1 is returned if an error occurred, e.g. if a shader program could not be compiled or a compile target is not reachable. The error strings are then printed to the error log and can be caught with a custom event receiver.

◆ addShaderMaterial()

virtual dcpp::int32_kt dcpp::video::IGPUProgrammingServices::addShaderMaterial	(	const dcpp::char_kt *	vertexShaderProgram = `0`,
		const dcpp::char_kt *	pixelShaderProgram = `0`,
		IShaderConstantSetCallBack *	callback = `0`,
		E_MATERIAL_TYPE	baseMaterial = `dcpp::video::EMT_SOLID`,
		dcpp::int32_kt	userData = `0`
	)

pure virtual

Adds a new ASM shader material renderer to the VideoDriver.

Note that it is a good idea to call IVideoDriver::queryFeature() in advance to check if the IVideoDriver supports the vertex and/or pixel shader version your are using.

The material is added to the VideoDriver like with IVideoDriver::addMaterialRenderer() and can be used like it had been added with that method.

Parameters

vertexShaderProgram String containing the source of the vertex shader program. This can be 0 if no vertex program shall be used.

For DX8 programs, the will always input registers look like this: v0: position, v1: normal, v2: color, v3: texture coordinates, v4: texture coordinates 2 if available.

For DX9 programs, you can manually set the registers using the dcl_ statements.

Parameters

pixelShaderProgram	String containing the source of the pixel shader program. This can be 0 if you don't want to use a pixel shader.
callback	Pointer to an implementation of IShaderConstantSetCallBack in which you can set the needed vertex and pixel shader program constants. Set this to 0 if you don't need this.
baseMaterial	Base material which renderstates will be used to shade the material.
userData	a user data int. This int can be set to any value and will be set as parameter in the callback method when calling OnSetConstants(). In this way it is easily possible to use the same callback method for multiple materials and distinguish between them during the call.

Returns: Returns the number of the material type which can be set in SMaterial::MaterialType to use the renderer. -1 is returned if an error occurred. -1 is returned for example if a vertex or pixel shader program could not be compiled, the error strings are then printed out into the error log, and can be caught with a custom event receiver.

◆ addShaderMaterialFromFiles() [1/2]

virtual dcpp::int32_kt dcpp::video::IGPUProgrammingServices::addShaderMaterialFromFiles	(	const dcpp::io::path &	vertexShaderProgramFileName,
		const dcpp::io::path &	pixelShaderProgramFileName,
		IShaderConstantSetCallBack *	callback = `0`,
		E_MATERIAL_TYPE	baseMaterial = `dcpp::video::EMT_SOLID`,
		dcpp::int32_kt	userData = `0`
	)

pure virtual

Like IGPUProgrammingServices::addShaderMaterial(), but loads from files.

Parameters

vertexShaderProgramFileName	Text file name containing the source of the vertex shader program. Set to 0 if no shader shall be created.
pixelShaderProgramFileName	Text file name containing the source of the pixel shader program. Set to 0 if no shader shall be created.
callback	Pointer to an IShaderConstantSetCallback object on which the OnSetConstants function is called.
baseMaterial	baseMaterial
userData	a user data int. This int can be set to any value and will be set as parameter in the callback method when calling OnSetConstants(). In this way it is easily possible to use the same callback method for multiple materials and distinguish between them during the call.

Returns: Returns the number of the material type which can be set in SMaterial::MaterialType to use the renderer. -1 is returned if an error occurred. -1 is returned for example if a vertex or pixel shader program could not be compiled, the error strings are then printed out into the error log, and can be caught with a custom event receiver.

◆ addShaderMaterialFromFiles() [2/2]

virtual dcpp::int32_kt dcpp::video::IGPUProgrammingServices::addShaderMaterialFromFiles	(	dcpp::io::IReadFile *	vertexShaderProgram,
		dcpp::io::IReadFile *	pixelShaderProgram,
		IShaderConstantSetCallBack *	callback = `0`,
		E_MATERIAL_TYPE	baseMaterial = `dcpp::video::EMT_SOLID`,
		dcpp::int32_kt	userData = `0`
	)

pure virtual

Like IGPUProgrammingServices::addShaderMaterial(), but loads from files.

Parameters

vertexShaderProgram	Text file containing the source of the vertex shader program. Set to 0 if no shader shall be created.
pixelShaderProgram	Text file containing the source of the pixel shader program. Set to 0 if no shader shall be created.
callback	Pointer to an IShaderConstantSetCallback object to which the OnSetConstants function is called.
baseMaterial	baseMaterial
userData	a user data int. This int can be set to any value and will be set as parameter in the callback method when calling OnSetConstants(). In this way it is easily possible to use the same callback method for multiple materials and distinguish between them during the call.

Returns: Returns the number of the material type which can be set in SMaterial::MaterialType to use the renderer. -1 is returned if an error occurred. -1 is returned for example if a vertex or pixel shader program could not be compiled, the error strings are then printed out into the error log, and can be caught with a custom event receiver.

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

include/duckcpp/core/engine/IGPUProgrammingServices.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ addHighLevelShaderMaterial() [1/3]

◆ addHighLevelShaderMaterial() [2/3]

◆ addHighLevelShaderMaterial() [3/3]

◆ addHighLevelShaderMaterialFromFiles() [1/4]

◆ addHighLevelShaderMaterialFromFiles() [2/4]

◆ addHighLevelShaderMaterialFromFiles() [3/4]

◆ addHighLevelShaderMaterialFromFiles() [4/4]

◆ addShaderMaterial()

◆ addShaderMaterialFromFiles() [1/2]

◆ addShaderMaterialFromFiles() [2/2]