Castor3D 0.12.0
Multiplatform 3D engine
Public Member Functions | Friends | List of all members
castor3d::GpuInformations Class Reference

#include <GpuInformations.hpp>

Public Member Functions

 GpuInformations ()
 Constructor. More...
 
void addFeature (GpuFeature feature)
 Adds a supported feature. More...
 
void removeFeature (GpuFeature feature)
 Removes a supported feature. More...
 
void updateFeature (GpuFeature feature, bool supported)
 Updates the support for a feature. More...
 
bool hasFeature (GpuFeature feature) const
 Tells if the feature is supported supports stereo. More...
 
bool hasStereoRendering () const
 
bool hasShaderStorageBuffers () const
 
bool hasShaderType (VkShaderStageFlagBits type) const
 
void useShaderType (VkShaderStageFlagBits type, bool value)
 Defines the support for given shader type. More...
 
uint32_t getValue (GpuMin index) const
 
void setValue (GpuMin index, uint32_t value)
 
uint32_t getValue (GpuMax index) const
 
void setValue (GpuMax index, uint32_t value)
 
uint32_t getTotalMemorySize () const
 
void setTotalMemorySize (uint32_t value)
 
castor::String const & getVendor () const
 
void setVendor (castor::String const &value)
 
castor::String const & getRenderer () const
 
void setRenderer (castor::String const &value)
 
castor::String const & getVersion () const
 
void setVersion (castor::String const &value)
 

Friends

class Context
 

Constructor & Destructor Documentation

◆ GpuInformations()

castor3d::GpuInformations::GpuInformations ( )
inline

Constructor.

Member Function Documentation

◆ addFeature()

void castor3d::GpuInformations::addFeature ( GpuFeature  feature)
inline

Adds a supported feature.

Referenced by updateFeature().

Here is the caller graph for this function:

◆ getRenderer()

castor::String const & castor3d::GpuInformations::getRenderer ( ) const
inline
Returns
The GPU platform.

◆ getTotalMemorySize()

uint32_t castor3d::GpuInformations::getTotalMemorySize ( ) const
inline
Returns
The total VRAM size.

◆ getValue() [1/2]

uint32_t castor3d::GpuInformations::getValue ( GpuMax  index) const
inline
Parameters
[in]indexThe index.
Returns
The maximum value for given index.

◆ getValue() [2/2]

uint32_t castor3d::GpuInformations::getValue ( GpuMin  index) const
inline
Parameters
[in]indexThe index.
Returns
The minimum value for given index.

Referenced by castor3d::RenderSystem::getValue().

Here is the caller graph for this function:

◆ getVendor()

castor::String const & castor3d::GpuInformations::getVendor ( ) const
inline
Returns
The GPU vendor name.

◆ getVersion()

castor::String const & castor3d::GpuInformations::getVersion ( ) const
inline
Returns
The rendering API version.

◆ hasFeature()

bool castor3d::GpuInformations::hasFeature ( GpuFeature  feature) const
inline

Tells if the feature is supported supports stereo.

Referenced by castor3d::RenderSystem::hasFeature(), hasShaderStorageBuffers(), and hasStereoRendering().

Here is the caller graph for this function:

◆ hasShaderStorageBuffers()

bool castor3d::GpuInformations::hasShaderStorageBuffers ( ) const
inline
Returns
The SSBO support status.

References castor3d::eShaderStorageBuffers, and hasFeature().

Referenced by castor3d::RenderSystem::hasShaderStorageBuffers().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ hasShaderType()

bool castor3d::GpuInformations::hasShaderType ( VkShaderStageFlagBits  type) const
inline
Parameters
[in]typeThe shader type.
Returns
The shader type support status.

Referenced by castor3d::RenderSystem::hasShaderType().

Here is the caller graph for this function:

◆ hasStereoRendering()

bool castor3d::GpuInformations::hasStereoRendering ( ) const
inline
Returns
The stereo support status.

References castor3d::eStereoRendering, and hasFeature().

Referenced by castor3d::RenderSystem::hasStereoRendering().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ removeFeature()

void castor3d::GpuInformations::removeFeature ( GpuFeature  feature)
inline

Removes a supported feature.

Referenced by updateFeature().

Here is the caller graph for this function:

◆ setRenderer()

void castor3d::GpuInformations::setRenderer ( castor::String const &  value)
inline
Parameters
[in]valueThe GPU platform.

◆ setTotalMemorySize()

void castor3d::GpuInformations::setTotalMemorySize ( uint32_t  value)
inline
Parameters
[in]valueThe total VRAM size.

◆ setValue() [1/2]

void castor3d::GpuInformations::setValue ( GpuMax  index,
uint32_t  value 
)
inline
Parameters
[in]indexThe index.
[in]valueThe maximum value for given index.

◆ setValue() [2/2]

void castor3d::GpuInformations::setValue ( GpuMin  index,
uint32_t  value 
)
inline
Parameters
[in]indexThe index.
[in]valueThe minimum value for given index.

◆ setVendor()

void castor3d::GpuInformations::setVendor ( castor::String const &  value)
inline
Parameters
[in]valueThe GPU vendor name.

◆ setVersion()

void castor3d::GpuInformations::setVersion ( castor::String const &  value)
inline
Parameters
[in]valueThe rendering API version.

◆ updateFeature()

void castor3d::GpuInformations::updateFeature ( GpuFeature  feature,
bool  supported 
)
inline

Updates the support for a feature.

References addFeature(), and removeFeature().

Here is the call graph for this function:

◆ useShaderType()

void castor3d::GpuInformations::useShaderType ( VkShaderStageFlagBits  type,
bool  value 
)
inline

Defines the support for given shader type.

Parameters
[in]typeThe shader type.
[in]valueThe new value.

Friends And Related Function Documentation

◆ Context

friend class Context
friend

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