Blender  V3.3
Public Member Functions | List of all members
GHOST_ContextSDL Class Reference

#include <GHOST_ContextSDL.h>

Inheritance diagram for GHOST_ContextSDL:
GHOST_Context GHOST_IContext

Public Member Functions

 GHOST_ContextSDL (bool stereoVisual, SDL_Window *window, int contextProfileMask, int contextMajorVersion, int contextMinorVersion, int contextFlags, int contextResetNotificationStrategy)
 
 ~GHOST_ContextSDL ()
 
GHOST_TSuccess swapBuffers ()
 
GHOST_TSuccess activateDrawingContext ()
 
GHOST_TSuccess releaseDrawingContext ()
 
GHOST_TSuccess initializeDrawingContext ()
 
GHOST_TSuccess releaseNativeHandles ()
 
GHOST_TSuccess setSwapInterval (int interval)
 
GHOST_TSuccess getSwapInterval (int &intervalOut)
 
- Public Member Functions inherited from GHOST_Context
 GHOST_Context (bool stereoVisual)
 
virtual ~GHOST_Context ()
 
virtual GHOST_TSuccess updateDrawingContext ()
 
voidgetUserData ()
 
void setUserData (void *user_data)
 
bool isStereoVisual () const
 
virtual bool isUpsideDown () const
 
virtual unsigned int getDefaultFramebuffer ()
 
- Public Member Functions inherited from GHOST_IContext
virtual ~GHOST_IContext ()
 

Additional Inherited Members

- Protected Member Functions inherited from GHOST_Context
void initContextGLEW ()
 
- Static Protected Member Functions inherited from GHOST_Context
static void initClearGL ()
 
- Protected Attributes inherited from GHOST_Context
bool m_stereoVisual
 
voidm_user_data = nullptr
 

Detailed Description

Definition at line 28 of file GHOST_ContextSDL.h.

Constructor & Destructor Documentation

◆ GHOST_ContextSDL()

GHOST_ContextSDL::GHOST_ContextSDL ( bool  stereoVisual,
SDL_Window *  window,
int  contextProfileMask,
int  contextMajorVersion,
int  contextMinorVersion,
int  contextFlags,
int  contextResetNotificationStrategy 
)

Constructor.

Definition at line 21 of file GHOST_ContextSDL.cpp.

◆ ~GHOST_ContextSDL()

GHOST_ContextSDL::~GHOST_ContextSDL ( )

Destructor.

Definition at line 41 of file GHOST_ContextSDL.cpp.

Member Function Documentation

◆ activateDrawingContext()

GHOST_TSuccess GHOST_ContextSDL::activateDrawingContext ( )
virtual

Activates the drawing context of this window.

Returns
A boolean success indicator.

Implements GHOST_Context.

Definition at line 73 of file GHOST_ContextSDL.cpp.

References GHOST_kFailure, and GHOST_kSuccess.

◆ getSwapInterval()

GHOST_TSuccess GHOST_ContextSDL::getSwapInterval ( int &  intervalOut)
virtual

Gets the current swap interval for swapBuffers.

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

Reimplemented from GHOST_Context.

Definition at line 170 of file GHOST_ContextSDL.cpp.

References GHOST_kSuccess.

◆ initializeDrawingContext()

GHOST_TSuccess GHOST_ContextSDL::initializeDrawingContext ( )
virtual

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

Returns
Indication as to whether initialization has succeeded.

Implements GHOST_Context.

Definition at line 90 of file GHOST_ContextSDL.cpp.

References GHOST_kFailure, GHOST_kSuccess, GHOST_Context::initClearGL(), GHOST_Context::initContextGLEW(), and GHOST_Context::m_stereoVisual.

◆ releaseDrawingContext()

GHOST_TSuccess GHOST_ContextSDL::releaseDrawingContext ( )
virtual

Release the drawing context of the calling thread.

Returns
A boolean success indicator.

Implements GHOST_Context.

Definition at line 81 of file GHOST_ContextSDL.cpp.

References GHOST_kFailure, and GHOST_kSuccess.

◆ releaseNativeHandles()

GHOST_TSuccess GHOST_ContextSDL::releaseNativeHandles ( )
virtual

Removes references to native handles from this context and then returns

Returns
GHOST_kSuccess if it is OK for the parent to release the handles and GHOST_kFailure if releasing the handles will interfere with sharing

Implements GHOST_Context.

Definition at line 155 of file GHOST_ContextSDL.cpp.

References GHOST_kSuccess.

◆ setSwapInterval()

GHOST_TSuccess GHOST_ContextSDL::setSwapInterval ( int  interval)
virtual

Sets the swap interval for swapBuffers.

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

Reimplemented from GHOST_Context.

Definition at line 162 of file GHOST_ContextSDL.cpp.

References GHOST_kFailure, and GHOST_kSuccess.

◆ swapBuffers()

GHOST_TSuccess GHOST_ContextSDL::swapBuffers ( )
virtual

Swaps front and back buffers of a window.

Returns
A boolean success indicator.

Implements GHOST_Context.

Definition at line 66 of file GHOST_ContextSDL.cpp.

References GHOST_kSuccess.


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