spark::render::IGraphicsAdapter Class Reference

Represents a physical graphics adapter. More...

#include <GraphicsAdapter.h>

Inheritance diagram for spark::render::IGraphicsAdapter:

Public Member Functions
virtual std::string	name () const noexcept=0
	Gets the name of the graphics adapter.
virtual lib::Uuid	uuid () const noexcept=0
	Gets the unique identifier for the graphics adapter in the system.
virtual unsigned int	vendorId () const noexcept=0
	Gets an identifier representing the vendor of the graphics adapter.
virtual unsigned int	deviceId () const noexcept=0
	Gets an identifier representing the product.
virtual GraphicsAdapterType	type () const noexcept=0
	Gets the type of the graphics adapter.
virtual unsigned int	driverVersion () const noexcept=0
	Gets the version of the driver for the graphics adapter.
virtual unsigned int	apiVersion () const noexcept=0
	Gets the version of the API supported by the graphics adapter.
virtual unsigned long long int	dedicatedVideoMemory () const noexcept=0
	Gets the amount of dedicated video memory (in bytes) available on the graphics adapter.

Detailed Description

Represents a physical graphics adapter.

A graphics adapter is a physical device that can be used to render graphics. It typically is a GPU, but can also be a CPU with integrated graphics. However, it can also represent an emulated graphics adapter.

Member Function Documentation

apiVersion()

virtual unsigned int spark::render::IGraphicsAdapter::apiVersion ( ) const

nodiscardpure virtualnoexcept

Gets the version of the API supported by the graphics adapter.

Returns

A uint32 representing the version of the API supported by the graphics adapter.

Implemented in spark::render::vk::VulkanGraphicsAdapter.

dedicatedVideoMemory()

virtual unsigned long long int spark::render::IGraphicsAdapter::dedicatedVideoMemory ( ) const

nodiscardpure virtualnoexcept

Gets the amount of dedicated video memory (in bytes) available on the graphics adapter.

Returns

A uint64 representing the amount of dedicated video memory (in bytes) available on the graphics adapter.

Implemented in spark::render::vk::VulkanGraphicsAdapter.

deviceId()

virtual unsigned int spark::render::IGraphicsAdapter::deviceId ( ) const

nodiscardpure virtualnoexcept

Gets an identifier representing the product.

Returns

A uint32 representing the product.

Implemented in spark::render::vk::VulkanGraphicsAdapter.

driverVersion()

virtual unsigned int spark::render::IGraphicsAdapter::driverVersion ( ) const

nodiscardpure virtualnoexcept

Gets the version of the driver for the graphics adapter.

Returns

A uint32 representing the version of the driver for the graphics adapter.

Implemented in spark::render::vk::VulkanGraphicsAdapter.

name()

virtual std::string spark::render::IGraphicsAdapter::name ( ) const

nodiscardpure virtualnoexcept

Gets the name of the graphics adapter.

Returns

A std::string containing the name of the graphics adapter.

Implemented in spark::render::vk::VulkanGraphicsAdapter.

type()

virtual GraphicsAdapterType spark::render::IGraphicsAdapter::type ( ) const

nodiscardpure virtualnoexcept

Gets the type of the graphics adapter.

Returns

A GraphicsAdapter representing the type of the graphics adapter.

Implemented in spark::render::vk::VulkanGraphicsAdapter.

uuid()

virtual lib::Uuid spark::render::IGraphicsAdapter::uuid ( ) const

nodiscardpure virtualnoexcept

Gets the unique identifier for the graphics adapter in the system.

Returns

A lib::Uuid containing the unique identifier for the graphics adapter.

Implemented in spark::render::vk::VulkanGraphicsAdapter.

vendorId()

virtual unsigned int spark::render::IGraphicsAdapter::vendorId ( ) const

nodiscardpure virtualnoexcept

Gets an identifier representing the vendor of the graphics adapter.

Returns

A uint32 representing the vendor of the graphics adapter.

Implemented in spark::render::vk::VulkanGraphicsAdapter.