Skip to content

KDXr::Session

Module: Public API

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

#include <KDXr/session.h>

Public Functions

Name
Session()
~Session()
Session(Session && other)
Session & operator=(Session && other)
Session(const Session & ) =delete
Session & operator=(const Session & ) =delete
KDGpu::Handle< Session_t > handle() const
Returns the handle used to retrieve the underlying XR API specific Session.
bool isValid() const
Convenience function to check whether the object is actually referencing a valid API specific resource.
operator KDGpu::Handle< Session_t >() const
ReferenceSpace createReferenceSpace(const ReferenceSpaceOptions & options =ReferenceSpaceOptions())
std::span< const KDGpu::Format > supportedSwapchainFormats() const
KDGpu::Format selectSwapchainFormat(std::span< const KDGpu::Format > preferredFormats) const
Swapchain createSwapchain(const SwapchainOptions & options)
void setViewConfigurationType(ViewConfigurationType viewConfigurationType)
ViewConfigurationType viewConfigurationType() const
bool isActive() const
FrameState waitForFrame()
BeginFrameResult beginFrame()
EndFrameResult endFrame(const EndFrameOptions & options)
LocateViewsResult locateViews(const LocateViewsOptions & options, ViewState & viewState)
AttachActionSetsResult attachActionSets(const AttachActionSetsOptions & options)
InteractionProfileState getInteractionProfile(const GetInterationProfileOptions & options) const
SyncActionsResult syncActions(const SyncActionsOptions & options)
ReferenceSpace createActionSpace(const ActionSpaceOptions & options)
GetActionStateResult getBooleanState(const GetActionStateOptions & options, ActionStateBoolean & state) const
GetActionStateResult getFloatState(const GetActionStateOptions & options, ActionStateFloat & state) const
GetActionStateResult getVector2State(const GetActionStateOptions & options, ActionStateVector2 & state) const
GetActionStateResult getPoseState(const GetActionStateOptions & options, ActionStatePose & state) const
VibrateOutputResult vibrateOutput(const VibrationOutputOptions & options)

Public Attributes

Name
KDBindings::Property< SessionState > state
KDBindings::Property< bool > running
KDBindings::Property< bool > autoRun

Friends

Name
class System

Detailed Description

1
class KDXr::Session;

Session is used to initialize the XR API.

See: SessionOptions

Public Functions Documentation

function Session

1
Session()

function ~Session

1
~Session()

function Session

1
2
3
Session(
    Session && other
)

function operator=

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

function Session

1
2
3
Session(
    const Session & 
) =delete

function operator=

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

function handle

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

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

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< Session_t >

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

function createReferenceSpace

1
2
3
ReferenceSpace createReferenceSpace(
    const ReferenceSpaceOptions & options =ReferenceSpaceOptions()
)

function supportedSwapchainFormats

1
std::span< const KDGpu::Format > supportedSwapchainFormats() const

function selectSwapchainFormat

1
2
3
KDGpu::Format selectSwapchainFormat(
    std::span< const KDGpu::Format > preferredFormats
) const

function createSwapchain

1
2
3
Swapchain createSwapchain(
    const SwapchainOptions & options
)

function setViewConfigurationType

1
2
3
inline void setViewConfigurationType(
    ViewConfigurationType viewConfigurationType
)

function viewConfigurationType

1
inline ViewConfigurationType viewConfigurationType() const

function isActive

1
inline bool isActive() const

function waitForFrame

1
FrameState waitForFrame()

function beginFrame

1
BeginFrameResult beginFrame()

function endFrame

1
2
3
EndFrameResult endFrame(
    const EndFrameOptions & options
)

function locateViews

1
2
3
4
LocateViewsResult locateViews(
    const LocateViewsOptions & options,
    ViewState & viewState
)

function attachActionSets

1
2
3
AttachActionSetsResult attachActionSets(
    const AttachActionSetsOptions & options
)

function getInteractionProfile

1
2
3
InteractionProfileState getInteractionProfile(
    const GetInterationProfileOptions & options
) const

function syncActions

1
2
3
SyncActionsResult syncActions(
    const SyncActionsOptions & options
)

function createActionSpace

1
2
3
ReferenceSpace createActionSpace(
    const ActionSpaceOptions & options
)

function getBooleanState

1
2
3
4
GetActionStateResult getBooleanState(
    const GetActionStateOptions & options,
    ActionStateBoolean & state
) const

function getFloatState

1
2
3
4
GetActionStateResult getFloatState(
    const GetActionStateOptions & options,
    ActionStateFloat & state
) const

function getVector2State

1
2
3
4
GetActionStateResult getVector2State(
    const GetActionStateOptions & options,
    ActionStateVector2 & state
) const

function getPoseState

1
2
3
4
GetActionStateResult getPoseState(
    const GetActionStateOptions & options,
    ActionStatePose & state
) const

function vibrateOutput

1
2
3
VibrateOutputResult vibrateOutput(
    const VibrationOutputOptions & options
)

Public Attributes Documentation

variable state

1
KDBindings::Property< SessionState > state { SessionState::Unknown };

variable running

1
KDBindings::Property< bool > running { false };

variable autoRun

1
KDBindings::Property< bool > autoRun { true };

Friends

friend System

1
2
3
friend class System(
    System 
);

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