Blender V5.0
Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
GHOST_Context Class Referenceabstract

#include <GHOST_Context.hh>

Inherits GHOST_IContext.

Inherited by GHOST_ContextD3D, GHOST_ContextEGL, GHOST_ContextGLX, GHOST_ContextMTL, GHOST_ContextNone, GHOST_ContextSDL, GHOST_ContextVK, and GHOST_ContextWGL.

Public Member Functions

 GHOST_Context (const GHOST_ContextParams &context_params)
 ~GHOST_Context () override
GHOST_TSuccess swapBufferAcquire () override=0
GHOST_TSuccess swapBufferRelease () override=0
GHOST_TSuccess activateDrawingContext () override=0
GHOST_TSuccess releaseDrawingContext () override=0
virtual GHOST_TSuccess initializeDrawingContext ()=0
virtual GHOST_TSuccess updateDrawingContext ()
virtual GHOST_TSuccess releaseNativeHandles ()=0
virtual GHOST_TSuccess setSwapInterval (int)
virtual GHOST_TSuccess getSwapInterval (int &)
void * getUserData ()
void setUserData (void *user_data)
bool isStereoVisual () const
virtual GHOST_TVSyncModes getVSync ()
virtual bool isUpsideDown () const
unsigned int getDefaultFramebuffer () override
Public Member Functions inherited from GHOST_IContext
virtual ~GHOST_IContext ()=default

Static Public Member Functions

static GHOST_Context * getActiveDrawingContext ()
Static Public Member Functions inherited from GHOST_IContext
static GHOST_IContext * getActiveDrawingContext ()

Protected Attributes

GHOST_ContextParams context_params_
void * user_data_ = nullptr

Static Protected Attributes

static GHOST_Context * active_context_

Detailed Description

Definition at line 17 of file GHOST_Context.hh.

Constructor & Destructor Documentation

◆ GHOST_Context()

GHOST_Context::GHOST_Context ( const GHOST_ContextParams & context_params)
inline

Constructor.

Parameters
context_paramsParameters to use when initializing the context.

Definition at line 26 of file GHOST_Context.hh.

References context_params_.

Referenced by getActiveDrawingContext(), GHOST_ContextD3D::GHOST_ContextD3D(), GHOST_ContextEGL::GHOST_ContextEGL(), GHOST_ContextGLX::GHOST_ContextGLX(), GHOST_ContextMTL::GHOST_ContextMTL(), GHOST_ContextNone::GHOST_ContextNone(), GHOST_ContextSDL::GHOST_ContextSDL(), GHOST_ContextVK::GHOST_ContextVK(), and GHOST_ContextWGL::GHOST_ContextWGL().

◆ ~GHOST_Context()

GHOST_Context::~GHOST_Context ( )
inlineoverride

Destructor.

Definition at line 31 of file GHOST_Context.hh.

References active_context_.

Member Function Documentation

◆ activateDrawingContext()

GHOST_TSuccess GHOST_Context::activateDrawingContext ( )
overridepure virtual

Activates the drawing context.

Returns
A boolean success indicator.

Implements GHOST_IContext.

Implemented in GHOST_ContextD3D, GHOST_ContextEGL, GHOST_ContextGLX, GHOST_ContextMTL, GHOST_ContextNone, GHOST_ContextSDL, GHOST_ContextVK, and GHOST_ContextWGL.

◆ getActiveDrawingContext()

GHOST_Context * GHOST_Context::getActiveDrawingContext ( )
inlinestatic

Returns the thread's currently active drawing context.

Definition at line 41 of file GHOST_Context.hh.

References active_context_, and GHOST_Context().

Referenced by GHOST_IContext::getActiveDrawingContext().

◆ getDefaultFramebuffer()

unsigned int GHOST_Context::getDefaultFramebuffer ( )
inlineoverridevirtual

Gets the OpenGL frame-buffer associated with the OpenGL context

Returns
The ID of an OpenGL frame-buffer object.

Implements GHOST_IContext.

Reimplemented in GHOST_ContextD3D, and GHOST_ContextMTL.

Definition at line 141 of file GHOST_Context.hh.

◆ getSwapInterval()

virtual GHOST_TSuccess GHOST_Context::getSwapInterval ( int & )
inlinevirtual

Gets the current swap interval for #swapBuffers.

Parameters
interval_outVariable to store the swap interval if it can be read.
Returns
Whether the swap interval can be read.

Reimplemented in GHOST_ContextD3D, GHOST_ContextEGL, GHOST_ContextGLX, GHOST_ContextMTL, GHOST_ContextNone, GHOST_ContextSDL, GHOST_ContextVK, and GHOST_ContextWGL.

Definition at line 95 of file GHOST_Context.hh.

References GHOST_kFailure.

◆ getUserData()

void * GHOST_Context::getUserData ( )
inline

Get user data.

Definition at line 103 of file GHOST_Context.hh.

References user_data_.

◆ getVSync()

virtual GHOST_TVSyncModes GHOST_Context::getVSync ( )
inlinevirtual

Get the VSync value.

Definition at line 127 of file GHOST_Context.hh.

References context_params_.

Referenced by GHOST_ContextMTL::GHOST_ContextMTL(), GHOST_ContextEGL::initializeDrawingContext(), GHOST_ContextGLX::initializeDrawingContext(), GHOST_ContextSDL::initializeDrawingContext(), and GHOST_ContextWGL::initializeDrawingContext().

◆ initializeDrawingContext()

virtual GHOST_TSuccess GHOST_Context::initializeDrawingContext ( )
pure virtual

Call immediately after new to initialize. If this fails then immediately delete the object.

Returns
Indication as to whether initialization has succeeded.

Implemented in GHOST_ContextD3D, GHOST_ContextEGL, GHOST_ContextGLX, GHOST_ContextMTL, GHOST_ContextNone, GHOST_ContextSDL, GHOST_ContextVK, and GHOST_ContextWGL.

◆ isStereoVisual()

bool GHOST_Context::isStereoVisual ( ) const
inline

Stereo visual created. Only necessary for 'real' stereo support, ie quad buffered stereo. This is not always possible, depends on the graphics h/w

Definition at line 121 of file GHOST_Context.hh.

References context_params_.

◆ isUpsideDown()

virtual bool GHOST_Context::isUpsideDown ( ) const
inlinevirtual

Returns if the context is rendered upside down compared to OpenGL.

Reimplemented in GHOST_ContextD3D, and GHOST_ContextVK.

Definition at line 135 of file GHOST_Context.hh.

Referenced by GHOST_XrGraphicsBindingVulkan::needsUpsideDownDrawing().

◆ releaseDrawingContext()

GHOST_TSuccess GHOST_Context::releaseDrawingContext ( )
overridepure virtual

Release the drawing context of the calling thread.

Returns
A boolean success indicator.

Implements GHOST_IContext.

Implemented in GHOST_ContextD3D, GHOST_ContextEGL, GHOST_ContextGLX, GHOST_ContextMTL, GHOST_ContextNone, GHOST_ContextSDL, GHOST_ContextVK, and GHOST_ContextWGL.

◆ releaseNativeHandles()

virtual GHOST_TSuccess GHOST_Context::releaseNativeHandles ( )
pure virtual

Checks if it is OK for a remove the native display

Returns
Indication as to whether removal has succeeded.

Implemented in GHOST_ContextD3D, GHOST_ContextEGL, GHOST_ContextGLX, GHOST_ContextMTL, GHOST_ContextNone, GHOST_ContextSDL, GHOST_ContextVK, and GHOST_ContextWGL.

◆ setSwapInterval()

virtual GHOST_TSuccess GHOST_Context::setSwapInterval ( int )
inlinevirtual

Sets the swap interval for #swapBuffers.

Parameters
intervalThe swap interval to use.
Returns
A boolean success indicator.

Reimplemented in GHOST_ContextD3D, GHOST_ContextEGL, GHOST_ContextGLX, GHOST_ContextMTL, GHOST_ContextNone, GHOST_ContextSDL, GHOST_ContextVK, and GHOST_ContextWGL.

Definition at line 85 of file GHOST_Context.hh.

References GHOST_kFailure.

◆ setUserData()

void GHOST_Context::setUserData ( void * user_data)
inline

Set user data (intended for the caller to use as needed).

Definition at line 111 of file GHOST_Context.hh.

References user_data_.

◆ swapBufferAcquire()

GHOST_TSuccess GHOST_Context::swapBufferAcquire ( )
overridepure virtual

Implements GHOST_IContext.

Implemented in GHOST_ContextD3D, GHOST_ContextEGL, GHOST_ContextGLX, GHOST_ContextMTL, GHOST_ContextNone, GHOST_ContextSDL, GHOST_ContextVK, and GHOST_ContextWGL.

◆ swapBufferRelease()

GHOST_TSuccess GHOST_Context::swapBufferRelease ( )
overridepure virtual

Implements GHOST_IContext.

Implemented in GHOST_ContextD3D, GHOST_ContextEGL, GHOST_ContextGLX, GHOST_ContextMTL, GHOST_ContextNone, GHOST_ContextSDL, GHOST_ContextVK, and GHOST_ContextWGL.

◆ updateDrawingContext()

virtual GHOST_TSuccess GHOST_Context::updateDrawingContext ( )
inlinevirtual

Updates the drawing context of this window. Needed whenever the window is changed.

Returns
Indication of success.

Reimplemented in GHOST_ContextD3D, GHOST_ContextMTL, and GHOST_ContextNone.

Definition at line 69 of file GHOST_Context.hh.

References GHOST_kFailure.

Member Data Documentation

◆ active_context_

GHOST_Context* GHOST_Context::active_context_
inlinethread_localstaticprotected

Definition at line 19 of file GHOST_Context.hh.

Referenced by GHOST_ContextD3D::activateDrawingContext(), GHOST_ContextEGL::activateDrawingContext(), GHOST_ContextGLX::activateDrawingContext(), GHOST_ContextMTL::activateDrawingContext(), GHOST_ContextNone::activateDrawingContext(), GHOST_ContextSDL::activateDrawingContext(), GHOST_ContextVK::activateDrawingContext(), GHOST_ContextWGL::activateDrawingContext(), getActiveDrawingContext(), GHOST_ContextD3D::initializeDrawingContext(), GHOST_ContextEGL::initializeDrawingContext(), GHOST_ContextGLX::initializeDrawingContext(), GHOST_ContextMTL::initializeDrawingContext(), GHOST_ContextNone::initializeDrawingContext(), GHOST_ContextSDL::initializeDrawingContext(), GHOST_ContextVK::initializeDrawingContext(), GHOST_ContextWGL::initializeDrawingContext(), GHOST_ContextD3D::releaseDrawingContext(), GHOST_ContextEGL::releaseDrawingContext(), GHOST_ContextGLX::releaseDrawingContext(), GHOST_ContextMTL::releaseDrawingContext(), GHOST_ContextNone::releaseDrawingContext(), GHOST_ContextSDL::releaseDrawingContext(), GHOST_ContextVK::releaseDrawingContext(), GHOST_ContextWGL::releaseDrawingContext(), and ~GHOST_Context().

◆ context_params_

GHOST_ContextParams GHOST_Context::context_params_
protected

Definition at line 172 of file GHOST_Context.hh.

Referenced by getVSync(), GHOST_Context(), GHOST_ContextMTL::GHOST_ContextMTL(), GHOST_ContextEGL::initializeDrawingContext(), GHOST_ContextGLX::initializeDrawingContext(), GHOST_ContextSDL::initializeDrawingContext(), GHOST_ContextVK::initializeDrawingContext(), GHOST_ContextWGL::initializeDrawingContext(), and isStereoVisual().

◆ user_data_

void* GHOST_Context::user_data_ = nullptr
protected

Caller specified, not for internal use.

Definition at line 175 of file GHOST_Context.hh.

Referenced by getUserData(), and setUserData().

The documentation for this class was generated from the following file:
Generated on for Blender by  doxygen 1.16.1