Blender V5.3
GHOST_IXrGraphicsBinding Class Referenceabstract

#include <GHOST_IXrGraphicsBinding.hh>

Inherited by GHOST_XrGraphicsBindingD3D, GHOST_XrGraphicsBindingMetal, and GHOST_XrGraphicsBindingVulkan.

Classes

union  [union].oxr_binding

Public Member Functions

virtual ~GHOST_IXrGraphicsBinding ()=default
virtual bool loadExtensionFunctions (XrInstance instance)=0
 load the functions for the graphics binding.
virtual bool checkVersionRequirements (class GHOST_Context &ghost_ctx, XrInstance instance, XrSystemId system_id, std::string *r_requirement_info) const =0
virtual void initFromGhostContext (class GHOST_Context &ghost_ctx, XrInstance instance, XrSystemId system_id)=0
virtual std::optional< int64_t > chooseSwapchainFormat (const std::vector< int64_t > &runtime_formats, GHOST_TXrSwapchainFormat &r_format, bool &r_is_rgb_format) const =0
virtual std::vector< XrSwapchainImageBaseHeader * > createSwapchainImages (uint32_t image_count)=0
virtual void submitToSwapchainBegin ()=0
virtual void submitToSwapchainImage (XrSwapchainImageBaseHeader &swapchain_image, const GHOST_XrDrawViewInfo &draw_info)=0
virtual void submitToSwapchainEnd ()=0
virtual bool needsUpsideDownDrawing (GHOST_Context &ghost_ctx) const =0

Public Attributes

union  oxr_binding

Protected Member Functions

 GHOST_IXrGraphicsBinding ()=default

Detailed Description

Definition at line 19 of file GHOST_IXrGraphicsBinding.hh.

Constructor & Destructor Documentation

◆ ~GHOST_IXrGraphicsBinding()

virtual GHOST_IXrGraphicsBinding::~GHOST_IXrGraphicsBinding ( )
virtualdefault

◆ GHOST_IXrGraphicsBinding()

GHOST_IXrGraphicsBinding::GHOST_IXrGraphicsBinding ( )
protecteddefault

Member Function Documentation

◆ checkVersionRequirements()

virtual bool GHOST_IXrGraphicsBinding::checkVersionRequirements ( class GHOST_Context & ghost_ctx,
XrInstance instance,
XrSystemId system_id,
std::string * r_requirement_info ) const
pure virtual

Does not require this object to be initialized (can be called prior to initFromGhostContext). It's actually meant to be called first.

Parameters
r_requirement_infoReturn argument to retrieve an informal string on the requirements. to be met. Useful for error/debug messages.

Implemented in GHOST_XrGraphicsBindingD3D, GHOST_XrGraphicsBindingMetal, and GHOST_XrGraphicsBindingVulkan.

◆ chooseSwapchainFormat()

virtual std::optional< int64_t > GHOST_IXrGraphicsBinding::chooseSwapchainFormat ( const std::vector< int64_t > & runtime_formats,
GHOST_TXrSwapchainFormat & r_format,
bool & r_is_rgb_format ) const
pure virtual

◆ createSwapchainImages()

virtual std::vector< XrSwapchainImageBaseHeader * > GHOST_IXrGraphicsBinding::createSwapchainImages ( uint32_t image_count)
pure virtual

◆ initFromGhostContext()

virtual void GHOST_IXrGraphicsBinding::initFromGhostContext ( class GHOST_Context & ghost_ctx,
XrInstance instance,
XrSystemId system_id )
pure virtual

◆ loadExtensionFunctions()

virtual bool GHOST_IXrGraphicsBinding::loadExtensionFunctions ( XrInstance instance)
pure virtual

load the functions for the graphics binding.

A graphic binding uses an extension. These extensions provide graphics platform specific functions. This function is called before checkVersionRequirements allowing to preload the function pointers.

Parameters
instanceXrInstance where to retrieve the functions from.
Returns
true when the extensions functions were successfully loaded, return false when the extension functions could not be loaded or would not allow to use the binding.
Note
These functions should be stored as instance variable as they can differ between XrSessions.

Implemented in GHOST_XrGraphicsBindingD3D, GHOST_XrGraphicsBindingMetal, and GHOST_XrGraphicsBindingVulkan.

◆ needsUpsideDownDrawing()

virtual bool GHOST_IXrGraphicsBinding::needsUpsideDownDrawing ( GHOST_Context & ghost_ctx) const
pure virtual

◆ submitToSwapchainBegin()

virtual void GHOST_IXrGraphicsBinding::submitToSwapchainBegin ( )
pure virtual

◆ submitToSwapchainEnd()

virtual void GHOST_IXrGraphicsBinding::submitToSwapchainEnd ( )
pure virtual

◆ submitToSwapchainImage()

virtual void GHOST_IXrGraphicsBinding::submitToSwapchainImage ( XrSwapchainImageBaseHeader & swapchain_image,
const GHOST_XrDrawViewInfo & draw_info )
pure virtual

Member Data Documentation

◆ oxr_binding


The documentation for this class was generated from the following file: