Skip to content

KDXr::System

Module: Public API

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

#include <KDXr/system.h>

Public Functions

Name
System() =default
~System()
System(System && other)
System & operator=(System && other)
System(const System & ) =delete
System & operator=(const System & ) =delete
KDGpu::Handle< System_t > handle() const
Returns the handle used to retrieve the underlying XR API specific System.
bool isValid() const
Convenience function to check whether the object is actually referencing a valid API specific resource.
operator KDGpu::Handle< System_t >() const
SystemProperties properties() const
std::span< const ViewConfigurationType > viewConfigurations() const
ViewConfigurationType selectViewConfiguration(std::span< const ViewConfigurationType > preferredViewConfigurations) const
std::vector< EnvironmentBlendMode > environmentBlendModes(ViewConfigurationType viewConfiguration) const
std::vector< ViewConfigurationView > views(ViewConfigurationType viewConfiguration) const
void setGraphicsApi(KDGpu::GraphicsApi * graphicsApi)
KDGpu::GraphicsApi * graphicsApi() const
GraphicsRequirements graphicsRequirements() const
std::vector< std::string > requiredGraphicsInstanceExtensions() const
KDGpu::Adapter * requiredGraphicsAdapter(const KDGpu::Instance & graphicsInstance) const
std::vector< std::string > requiredGraphicsDeviceExtensions() const
Session createSession(const SessionOptions & options)

Friends

Name
class Instance

Detailed Description

1
class KDXr::System;

System is used to initialize the XR API.

See: SystemOptions

Public Functions Documentation

function System

1
System() =default

function ~System

1
~System()

function System

1
2
3
System(
    System && other
)

function operator=

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

function System

1
2
3
System(
    const System & 
) =delete

function operator=

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

function handle

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

Returns the handle used to retrieve the underlying XR API specific System.

See: ResourceManager

Return: KDGpu::Handle

function isValid

1
inline bool isValid() const

Convenience function to check whether the object is actually referencing a valid API specific resource.

function operator KDGpu::Handle< System_t >

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

function properties

1
SystemProperties properties() const

function viewConfigurations

1
std::span< const ViewConfigurationType > viewConfigurations() const

function selectViewConfiguration

1
2
3
ViewConfigurationType selectViewConfiguration(
    std::span< const ViewConfigurationType > preferredViewConfigurations
) const

function environmentBlendModes

1
2
3
std::vector< EnvironmentBlendMode > environmentBlendModes(
    ViewConfigurationType viewConfiguration
) const

function views

1
2
3
std::vector< ViewConfigurationView > views(
    ViewConfigurationType viewConfiguration
) const

function setGraphicsApi

1
2
3
inline void setGraphicsApi(
    KDGpu::GraphicsApi * graphicsApi
)

function graphicsApi

1
inline KDGpu::GraphicsApi * graphicsApi() const

function graphicsRequirements

1
GraphicsRequirements graphicsRequirements() const

function requiredGraphicsInstanceExtensions

1
std::vector< std::string > requiredGraphicsInstanceExtensions() const

function requiredGraphicsAdapter

1
2
3
KDGpu::Adapter * requiredGraphicsAdapter(
    const KDGpu::Instance & graphicsInstance
) const

function requiredGraphicsDeviceExtensions

1
std::vector< std::string > requiredGraphicsDeviceExtensions() const

function createSession

1
2
3
Session createSession(
    const SessionOptions & options
)

Friends

friend Instance

1
2
3
friend class Instance(
    Instance 
);

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