#include <RenderSystem.hpp>

Inheritance diagram for castor3d::RenderSystem:

Collaboration diagram for castor3d::RenderSystem:

Public Member Functions
C3D_API	RenderSystem (Engine &engine, AshPluginDescription desc, Extensions instanceExtensions={}, Extensions deviceExtensions={})
	Constructor. More...

C3D_API	RenderSystem (Engine &engine, Renderer renderer, Extensions deviceExtensions={})
	Constructor. More...

C3D_API void	pushScene (Scene *scene)
	Pushes a scene on the stack. More...

C3D_API void	popScene ()
	Pops a scene from the stack. More...

C3D_API Scene *	getTopScene () const

C3D_API SpirVShader	compileShader (VkShaderStageFlagBits stage, castor::String const &name, ast::Shader const &shader) const
	Compiles a shader module to the necessary shader language. More...

C3D_API SpirVShader	compileShader (VkShaderStageFlagBits stage, castor::String const &name, castor::String const &glsl) const
	Compiles a shader module to the necessary shader language. More...

C3D_API SpirVShader	compileShader (ShaderModule const &module) const
	Compiles a shader module to the necessary shader language. More...

C3D_API castor::Matrix4x4f	getFrustum (float left, float right, float bottom, float top, float zNear, float zFar) const
	Computes an frustum projection matrix. More...

C3D_API castor::Matrix4x4f	getPerspective (castor::Angle const &fovy, float aspect, float zNear, float zFar) const

C3D_API castor::Matrix4x4f	getOrtho (float left, float right, float bottom, float top, float zNear, float zFar) const
	Computes an orthographic projection matrix. More...

C3D_API castor::Matrix4x4f	getInfinitePerspective (float radiansFovY, float aspect, float zNear) const


Getters.
AshPluginDescription const &	getDescription () const

GpuInformations const &	getGpuInformations () const

castor::String	getRendererType () const

bool	hasDevice () const

RenderDevice const &	getRenderDevice () const

OverlayRendererSPtr	getOverlayRenderer () const

castor::Nanoseconds const &	getGpuTime () const

bool	hasSsbo () const

ashes::Instance const &	getInstance () const

VkPhysicalDeviceProperties const &	getProperties () const

VkPhysicalDeviceMemoryProperties const &	getMemoryProperties () const

VkPhysicalDeviceFeatures const &	getFeatures () const

ashes::PhysicalDevice const &	getPhysicalDevice () const

bool	hasFeature (GpuFeature feature) const

bool	hasStereoRendering () const

bool	hasShaderStorageBuffers () const

bool	hasShaderType (VkShaderStageFlagBits type) const

uint32_t	getValue (GpuMin index) const

uint32_t	getValue (GpuMax index) const

bool	hasLLPV () const


template<class Rep , class Period >
void	incGpuTime (std::chrono::duration< Rep, Period > const &time)

void	resetGpuTime ()

Static Public Member Functions
static C3D_API ashes::InstancePtr	createInstance (Engine &engine, AshPluginDescription const &desc, Extensions &instanceExtensions)
	Creates a Vulkan instance usable with Castor3D. More...

static C3D_API void	completeLayerNames (Engine const &engine, ashes::VkLayerPropertiesArray const &layers, ashes::StringArray &names)
	Adds the instance layers names to the given names. More...

Constructor & Destructor Documentation

◆ RenderSystem() [1/2]

C3D_API castor3d::RenderSystem::RenderSystem	(	Engine &	engine,
		AshPluginDescription	desc,
		Extensions	instanceExtensions = `{}`,
		Extensions	deviceExtensions = `{}`
	)

Constructor.

Parameters

[in]	engine	The engine.
[in]	desc	The Ashes plugin description.
[in]	instanceExtensions	The instance extensions.
[in]	deviceExtensions	The device extensions.

◆ RenderSystem() [2/2]

C3D_API castor3d::RenderSystem::RenderSystem	(	Engine &	engine,
		Renderer	renderer,
		Extensions	deviceExtensions = `{}`
	)

Constructor.

Parameters

[in]	engine	The engine.
[in]	renderer	The selected renderer.
[in]	deviceExtensions	The device extensions.

Member Function Documentation

◆ compileShader() [1/3]

C3D_API SpirVShader castor3d::RenderSystem::compileShader ( ShaderModule const & module ) const

Compiles a shader module to the necessary shader language.

Parameters

[in] module The shader to compile.

Returns: The compiled shader.

◆ compileShader() [2/3]

C3D_API SpirVShader castor3d::RenderSystem::compileShader	(	VkShaderStageFlagBits	stage,
		castor::String const &	name,
		ast::Shader const &	shader
	)		const

Compiles a shader module to the necessary shader language.

Parameters

[in]	stage	The shader stage.
[in]	name	The shader name.
[in]	shader	The shader to compile.

Returns: The compiled shader.

◆ compileShader() [3/3]

C3D_API SpirVShader castor3d::RenderSystem::compileShader	(	VkShaderStageFlagBits	stage,
		castor::String const &	name,
		castor::String const &	glsl
	)		const

Compiles a shader module to the necessary shader language.

Parameters

[in]	stage	The shader stage.
[in]	name	The shader name.
[in]	glsl	The shader to compile.

Returns: The compiled shader.

◆ completeLayerNames()

static C3D_API void castor3d::RenderSystem::completeLayerNames	(	Engine const &	engine,
		ashes::VkLayerPropertiesArray const &	layers,
		ashes::StringArray &	names
	)

static

Adds the instance layers names to the given names.

Parameters

[in]	engine	The engine.
[in]	layers	The available layers.
[in,out]	names	The liste to fill.

◆ createInstance()

static C3D_API ashes::InstancePtr castor3d::RenderSystem::createInstance	(	Engine &	engine,
		AshPluginDescription const &	desc,
		Extensions &	instanceExtensions
	)

static

Creates a Vulkan instance usable with Castor3D.

Parameters

[in]	engine	The engine.
[in]	desc	The Ashes plugin description.
[in]	instanceExtensions	The instance extensions.

◆ getDescription()

AshPluginDescription const & castor3d::RenderSystem::getDescription ( ) const

inline

References castor3d::Renderer::desc.

Referenced by getRendererType(), and hasSsbo().

Here is the caller graph for this function:

◆ getFeatures()

VkPhysicalDeviceFeatures const & castor3d::RenderSystem::getFeatures ( ) const

inline

◆ getFrustum()

C3D_API castor::Matrix4x4f castor3d::RenderSystem::getFrustum	(	float	left,
		float	right,
		float	bottom,
		float	top,
		float	zNear,
		float	zFar
	)		const

Computes an frustum projection matrix.

Parameters

[in]	left,right	The left and right planes position.
[in]	top,bottom	The top and bottom planes position.
[in]	zNear,zFar	The near and far planes position.

◆ getGpuInformations()

GpuInformations const & castor3d::RenderSystem::getGpuInformations ( ) const

inline

◆ getGpuTime()

castor::Nanoseconds const & castor3d::RenderSystem::getGpuTime ( ) const

inline

◆ getInfinitePerspective()

C3D_API castor::Matrix4x4f castor3d::RenderSystem::getInfinitePerspective	(	float	radiansFovY,
		float	aspect,
		float	zNear
	)		const

Computes a perspective projection matrix with no far plane clipping.

Parameters

[in]	radiansFovY	The vertical aperture angle.
[in]	aspect	The width / height ratio.
[in]	zNear	The near plane position.

◆ getInstance()

ashes::Instance const & castor3d::RenderSystem::getInstance ( ) const

inline

References castor3d::Renderer::instance.

◆ getMemoryProperties()

VkPhysicalDeviceMemoryProperties const & castor3d::RenderSystem::getMemoryProperties ( ) const

inline

◆ getOrtho()

C3D_API castor::Matrix4x4f castor3d::RenderSystem::getOrtho	(	float	left,
		float	right,
		float	bottom,
		float	top,
		float	zNear,
		float	zFar
	)		const

Computes an orthographic projection matrix.

Parameters

[in]	left,right	The left and right planes position.
[in]	top,bottom	The top and bottom planes position.
[in]	zNear,zFar	The near and far planes position.

◆ getOverlayRenderer()

OverlayRendererSPtr castor3d::RenderSystem::getOverlayRenderer ( ) const

inline

◆ getPerspective()

C3D_API castor::Matrix4x4f castor3d::RenderSystem::getPerspective	(	castor::Angle const &	fovy,
		float	aspect,
		float	zNear,
		float	zFar
	)		const

Computes a perspective projection matrix.

Parameters

[in]	fovy	The vertical aperture angle.
[in]	aspect	The width / height ratio.
[in]	zNear	The near plane position.
[in]	zFar	The far plane position.

◆ getPhysicalDevice()

ashes::PhysicalDevice const & castor3d::RenderSystem::getPhysicalDevice ( ) const

inline

References castor3d::Renderer::gpu.

◆ getProperties()

VkPhysicalDeviceProperties const & castor3d::RenderSystem::getProperties ( ) const

inline

◆ getRenderDevice()

RenderDevice const & castor3d::RenderSystem::getRenderDevice ( ) const

inline

References hasDevice().

Here is the call graph for this function:

◆ getRendererType()

castor::String castor3d::RenderSystem::getRendererType ( ) const

inline

References getDescription().

Here is the call graph for this function:

◆ getTopScene()

C3D_API Scene * castor3d::RenderSystem::getTopScene ( ) const

Returns: The top scene from the stack, nullptr if the stack is empty.

◆ getValue() [1/2]

uint32_t castor3d::RenderSystem::getValue ( GpuMax index ) const

inline

References castor3d::GpuInformations::getValue().

Here is the call graph for this function:

◆ getValue() [2/2]

uint32_t castor3d::RenderSystem::getValue ( GpuMin index ) const

inline

References castor3d::GpuInformations::getValue().

Here is the call graph for this function:

◆ hasDevice()

bool castor3d::RenderSystem::hasDevice ( ) const

inline

Referenced by getRenderDevice().

Here is the caller graph for this function:

◆ hasFeature()

bool castor3d::RenderSystem::hasFeature ( GpuFeature feature ) const

inline

References castor3d::GpuInformations::hasFeature().

Here is the call graph for this function:

◆ hasLLPV()

bool castor3d::RenderSystem::hasLLPV ( ) const

inline

◆ hasShaderStorageBuffers()

bool castor3d::RenderSystem::hasShaderStorageBuffers ( ) const

inline

References castor3d::GpuInformations::hasShaderStorageBuffers().

Here is the call graph for this function:

◆ hasShaderType()

bool castor3d::RenderSystem::hasShaderType ( VkShaderStageFlagBits type ) const

inline

References castor3d::GpuInformations::hasShaderType().

Here is the call graph for this function:

◆ hasSsbo()

bool castor3d::RenderSystem::hasSsbo ( ) const

inline

References getDescription().

Here is the call graph for this function:

◆ hasStereoRendering()

bool castor3d::RenderSystem::hasStereoRendering ( ) const

inline

References castor3d::GpuInformations::hasStereoRendering().

Here is the call graph for this function:

◆ incGpuTime()

template<class Rep , class Period >

void castor3d::RenderSystem::incGpuTime ( std::chrono::duration< Rep, Period > const & time )

inline

name Mutators.

◆ popScene()

C3D_API void castor3d::RenderSystem::popScene ( )

Pops a scene from the stack.

◆ pushScene()

C3D_API void castor3d::RenderSystem::pushScene ( Scene * scene )

Pushes a scene on the stack.

Parameters

[in] scene The scene

◆ resetGpuTime()

void castor3d::RenderSystem::resetGpuTime ( )

inline

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

Render/RenderSystem.hpp

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

◆ RenderSystem() [1/2]

◆ RenderSystem() [2/2]

Member Function Documentation

◆ compileShader() [1/3]

◆ compileShader() [2/3]

◆ compileShader() [3/3]

◆ completeLayerNames()

◆ createInstance()

◆ getDescription()

◆ getFeatures()

◆ getFrustum()

◆ getGpuInformations()

◆ getGpuTime()

◆ getInfinitePerspective()

◆ getInstance()

◆ getMemoryProperties()

◆ getOrtho()

◆ getOverlayRenderer()

◆ getPerspective()

◆ getPhysicalDevice()

◆ getProperties()

◆ getRenderDevice()

◆ getRendererType()

◆ getTopScene()

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ hasDevice()

◆ hasFeature()

◆ hasLLPV()

◆ hasShaderStorageBuffers()

◆ hasShaderType()

◆ hasSsbo()

◆ hasStereoRendering()

◆ incGpuTime()

◆ popScene()

◆ pushScene()

◆ resetGpuTime()