KDGpu::Instance
Module: Public API
Instance is used to initialize the Rendering API. More...
#include <KDGpu/instance.h>
Public Functions
Friends
Detailed Description
Instance is used to initialize the Rendering API.
See:
| using namespace KDGpu;
std::unique_ptr<GraphicsApi> api = std::make_unique<VulkanGraphicsApi>();
Instance instance = api->createInstance(InstanceOptions{
.applicationName = "MyApplication",
.applicationVersion = 0,
});
|
Public Functions Documentation
function Instance
function ~Instance
function Instance
| Instance(
Instance && other
)
|
function operator=
| Instance & operator=(
Instance && other
)
|
function Instance
| Instance(
const Instance &
) =delete
|
function operator=
| Instance & operator=(
const Instance &
) =delete
|
function handle
| inline Handle< Instance_t > handle() const
|
function isValid
| inline bool isValid() const
|
function operator Handle< Instance_t >
| inline operator Handle< Instance_t >() const
|
function extensions
| std::vector< Extension > extensions() const
|
Returns the extensions requested for the instance.
function createDefaultDevice
| AdapterAndDevice createDefaultDevice(
const Surface & surface,
AdapterDeviceType deviceType =AdapterDeviceType::Default
) const
|
Convenience function used to create a Device instance that supports presentation against Surfacesurface.
function adapters
| std::vector< Adapter * > adapters() const
|
Returns a vector of the Adapter instances available for the instance.
function adapterGroups
| std::vector< AdapterGroup > adapterGroups() const
|
Returns a vector of the AdapterGroups available for the instance. AdapterGroup allow to spread operations across multiple adapters;.
function selectAdapter
| Adapter * selectAdapter(
AdapterDeviceType deviceType
) const
|
Convenience function to easily select an Adapter instance.
function createSurface
| Surface createSurface(
const SurfaceOptions & options
)
|
Create a Surface instance based on the provided options.
Friends
friend GraphicsApi
| friend class GraphicsApi(
GraphicsApi
);
|
friend VulkanGraphicsApi
| friend class VulkanGraphicsApi(
VulkanGraphicsApi
);
|
Updated on 2024-09-08 at 00:13:10 +0000