Skip to content

KDXr::Instance

Module: Public API

Instance is used to initialize the XR API. More...

#include <KDXr/instance.h>

Public Functions

Name
Instance()
~Instance()
Instance(Instance && other)
Instance & operator=(Instance && other)
Instance(const Instance & ) =delete
Instance & operator=(const Instance & ) =delete
KDGpu::Handle< Instance_t > handle() const
bool isValid() const
operator KDGpu::Handle< Instance_t >() const
std::vector< ApiLayer > enabledApiLayers() const
Returns the extensions requested for the instance.
std::vector< Extension > enabledExtensions() const
InstanceProperties properties() const
System * system(const SystemOptions & options =SystemOptions())
ProcessEventsResult processEvents()
ActionSet createActionSet(const ActionSetOptions & options)
SuggestActionBindingsResult suggestActionBindings(const SuggestActionBindingsOptions & options)

Public Attributes

Name
KDBindings::Signal instanceLost
KDBindings::Signal interactionProfileChanged

Friends

Name
class XrApi

Detailed Description

1
class KDXr::Instance;

Instance is used to initialize the XR API.

See: 

1
2
3
4
5
6
7
8
using namespace KDXr;

std::unique_ptr<XrApi> api = std::make_unique<OpenXrApi>();

Instance instance = api->createInstance(InstanceOptions{
        .applicationName = "MyApplication",
        .applicationVersion = 0,
});

Public Functions Documentation

function Instance

1
Instance()

function ~Instance

1
~Instance()

function Instance

1
2
3
Instance(
    Instance && other
)

function operator=

1
2
3
Instance & operator=(
    Instance && other
)

function Instance

1
2
3
Instance(
    const Instance & 
) =delete

function operator=

1
2
3
Instance & operator=(
    const Instance & 
) =delete

function handle

1
inline KDGpu::Handle< Instance_t > handle() const

function isValid

1
inline bool isValid() const

function operator KDGpu::Handle< Instance_t >

1
inline operator KDGpu::Handle< Instance_t >() const

function enabledApiLayers

1
std::vector< ApiLayer > enabledApiLayers() const

Returns the extensions requested for the instance.

function enabledExtensions

1
std::vector< Extension > enabledExtensions() const

function properties

1
InstanceProperties properties() const

function system

1
2
3
System * system(
    const SystemOptions & options =SystemOptions()
)

function processEvents

1
ProcessEventsResult processEvents()

function createActionSet

1
2
3
ActionSet createActionSet(
    const ActionSetOptions & options
)

function suggestActionBindings

1
2
3
SuggestActionBindingsResult suggestActionBindings(
    const SuggestActionBindingsOptions & options
)

Public Attributes Documentation

variable instanceLost

1
KDBindings::Signal instanceLost;

variable interactionProfileChanged

1
KDBindings::Signal interactionProfileChanged;

Friends

friend XrApi

1
2
3
friend class XrApi(
    XrApi 
);

Updated on 2025-07-08 at 12:01:11 +0000