LiteFX::Rendering::IGraphicsAdapter Class Reference

Represents a physical graphics adapter. More...

#include <rendering_api.hpp>

Inherited by LiteFX::Rendering::Backends::DirectX12GraphicsAdapter, and LiteFX::Rendering::Backends::VulkanGraphicsAdapter.

Public Member Functions
virtual	~IGraphicsAdapter () noexcept=default
virtual String	name () const noexcept=0
	Retrieves the name of the graphics adapter. More...
virtual UInt64	uniqueId () const noexcept=0
	Returns a unique identifier, that identifies the device in the system. More...
virtual UInt32	vendorId () const noexcept=0
	Returns a unique identifier, that identifies the vendor of the graphics adapter. More...
virtual UInt32	deviceId () const noexcept=0
	Returns a unique identifier, that identifies the product. More...
virtual GraphicsAdapterType	type () const noexcept=0
	Returns the type of the graphics adapter. More...
virtual UInt32	driverVersion () const noexcept=0
	Returns the graphics driver version. More...
virtual UInt32	apiVersion () const noexcept=0
	Returns the graphics API version. More...
virtual UInt64	dedicatedMemory () const noexcept=0
	Returns the amount of dedicated graphics memory (in bytes), this adapter can use. More...

Detailed Description

Represents a physical graphics adapter.

A graphics adapter can be seen as an actual physical device that can run graphics computations. Typically this resembles a GPU that is connected to the bus. However, it can also represent an emulated, virtual adapter, such as a software rasterizer.

Constructor & Destructor Documentation

~IGraphicsAdapter()

virtual LiteFX::Rendering::IGraphicsAdapter::~IGraphicsAdapter ( )

virtualdefaultnoexcept

Member Function Documentation

apiVersion()

virtual UInt32 LiteFX::Rendering::IGraphicsAdapter::apiVersion ( ) const

pure virtualnoexcept

Returns the graphics API version.

Returns

The graphics API version.

Implemented in LiteFX::Rendering::Backends::DirectX12GraphicsAdapter, and LiteFX::Rendering::Backends::VulkanGraphicsAdapter.

dedicatedMemory()

virtual UInt64 LiteFX::Rendering::IGraphicsAdapter::dedicatedMemory ( ) const

pure virtualnoexcept

Returns the amount of dedicated graphics memory (in bytes), this adapter can use.

Returns

The amount of dedicated graphics memory (in bytes), this adapter can use.

Implemented in LiteFX::Rendering::Backends::DirectX12GraphicsAdapter, and LiteFX::Rendering::Backends::VulkanGraphicsAdapter.

deviceId()

virtual UInt32 LiteFX::Rendering::IGraphicsAdapter::deviceId ( ) const

pure virtualnoexcept

Returns a unique identifier, that identifies the product.

Returns

A unique identifier, that identifies the product.

Implemented in LiteFX::Rendering::Backends::DirectX12GraphicsAdapter, and LiteFX::Rendering::Backends::VulkanGraphicsAdapter.

driverVersion()

virtual UInt32 LiteFX::Rendering::IGraphicsAdapter::driverVersion ( ) const

pure virtualnoexcept

Returns the graphics driver version.

Returns

The graphics driver version.

Implemented in LiteFX::Rendering::Backends::DirectX12GraphicsAdapter, and LiteFX::Rendering::Backends::VulkanGraphicsAdapter.

name()

virtual String LiteFX::Rendering::IGraphicsAdapter::name ( ) const

pure virtualnoexcept

Retrieves the name of the graphics adapter.

Returns

The name of the graphics adapter.

Implemented in LiteFX::Rendering::Backends::DirectX12GraphicsAdapter, and LiteFX::Rendering::Backends::VulkanGraphicsAdapter.

type()

virtual GraphicsAdapterType LiteFX::Rendering::IGraphicsAdapter::type ( ) const

pure virtualnoexcept

Returns the type of the graphics adapter.

Returns

The type of the graphics adapter.

Implemented in LiteFX::Rendering::Backends::DirectX12GraphicsAdapter, and LiteFX::Rendering::Backends::VulkanGraphicsAdapter.

uniqueId()

virtual UInt64 LiteFX::Rendering::IGraphicsAdapter::uniqueId ( ) const

pure virtualnoexcept

Returns a unique identifier, that identifies the device in the system.

Returns

A unique identifier, that identifies the device in the system.

Implemented in LiteFX::Rendering::Backends::DirectX12GraphicsAdapter, and LiteFX::Rendering::Backends::VulkanGraphicsAdapter.

vendorId()

virtual UInt32 LiteFX::Rendering::IGraphicsAdapter::vendorId ( ) const

pure virtualnoexcept

Returns a unique identifier, that identifies the vendor of the graphics adapter.

Returns

A unique identifier, that identifies the vendor of the graphics adapter.

Implemented in LiteFX::Rendering::Backends::DirectX12GraphicsAdapter, and LiteFX::Rendering::Backends::VulkanGraphicsAdapter.