GHOST_ContextSDL Class Reference

#include <GHOST_ContextSDL.hh>

Inherits GHOST_Context.

Public Member Functions
	GHOST_ContextSDL (const GHOST_ContextParams &context_params, SDL_Window *window, int contextProfileMask, int contextMajorVersion, int contextMinorVersion, int contextFlags, int contextResetNotificationStrategy)
	~GHOST_ContextSDL () override
GHOST_TSuccess	swapBufferAcquire () override
GHOST_TSuccess	swapBufferRelease () override
GHOST_TSuccess	activateDrawingContext () override
GHOST_TSuccess	releaseDrawingContext () override
GHOST_TSuccess	initializeDrawingContext () override
GHOST_TSuccess	releaseNativeHandles () override
GHOST_TSuccess	setSwapInterval (int interval) override
GHOST_TSuccess	getSwapInterval (int &interval_out) override
Public Member Functions inherited from GHOST_Context
	GHOST_Context (const GHOST_ContextParams &context_params)
	~GHOST_Context () override
virtual GHOST_TSuccess	updateDrawingContext ()
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

Additional Inherited Members
Static Public Member Functions inherited from GHOST_Context
static GHOST_Context *	getActiveDrawingContext ()
Static Public Member Functions inherited from GHOST_IContext
static GHOST_IContext *	getActiveDrawingContext ()
Protected Attributes inherited from GHOST_Context
GHOST_ContextParams	context_params_
void *	user_data_ = nullptr
Static Protected Attributes inherited from GHOST_Context
static GHOST_Context *	active_context_

Detailed Description

Definition at line 29 of file GHOST_ContextSDL.hh.

Constructor & Destructor Documentation

GHOST_ContextSDL()

GHOST_ContextSDL::GHOST_ContextSDL	(	const GHOST_ContextParams &	context_params,
		SDL_Window *	window,
		int	contextProfileMask,
		int	contextMajorVersion,
		int	contextMinorVersion,
		int	contextFlags,
		int	contextResetNotificationStrategy )

Constructor.

Definition at line 19 of file GHOST_ContextSDL.cc.

References GHOST_Context::GHOST_Context(), and nullptr.

~GHOST_ContextSDL()

GHOST_ContextSDL::~GHOST_ContextSDL ( )

override

Destructor.

Definition at line 39 of file GHOST_ContextSDL.cc.

References assert.

Member Function Documentation

activateDrawingContext()

GHOST_TSuccess GHOST_ContextSDL::activateDrawingContext ( )

overridevirtual

Activates the drawing context of this window.

Returns

A boolean success indicator.

Implements GHOST_Context.

Definition at line 71 of file GHOST_ContextSDL.cc.

References GHOST_Context::active_context_, GHOST_kFailure, and GHOST_kSuccess.

getSwapInterval()

GHOST_TSuccess GHOST_ContextSDL::getSwapInterval ( int & interval_out )

overridevirtual

Gets the current swap interval for #swapBuffers.

Parameters

interval_out

Variable 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 172 of file GHOST_ContextSDL.cc.

References GHOST_kSuccess.

initializeDrawingContext()

GHOST_TSuccess GHOST_ContextSDL::initializeDrawingContext ( )

overridevirtual

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.cc.

References GHOST_Context::active_context_, GHOST_Context::context_params_, GHOST_Context::getVSync(), GHOST_kFailure, GHOST_kSuccess, GHOST_kVSyncModeUnset, and setSwapInterval().

releaseDrawingContext()

GHOST_TSuccess GHOST_ContextSDL::releaseDrawingContext ( )

overridevirtual

Release the drawing context of the calling thread.

Returns

A boolean success indicator.

Implements GHOST_Context.

Definition at line 80 of file GHOST_ContextSDL.cc.

References GHOST_Context::active_context_, GHOST_kFailure, and GHOST_kSuccess.

releaseNativeHandles()

GHOST_TSuccess GHOST_ContextSDL::releaseNativeHandles ( )

overridevirtual

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 157 of file GHOST_ContextSDL.cc.

References GHOST_kSuccess.

setSwapInterval()

GHOST_TSuccess GHOST_ContextSDL::setSwapInterval ( int interval )

overridevirtual

Sets the swap interval for #swapBuffers.

Parameters

interval

The swap interval to use.

Returns

A boolean success indicator.

Reimplemented from GHOST_Context.

Definition at line 164 of file GHOST_ContextSDL.cc.

References GHOST_kFailure, and GHOST_kSuccess.

Referenced by initializeDrawingContext().

swapBufferAcquire()

GHOST_TSuccess GHOST_ContextSDL::swapBufferAcquire ( )

inlineoverridevirtual

Implements GHOST_Context.

Definition at line 48 of file GHOST_ContextSDL.hh.

References GHOST_kSuccess.

swapBufferRelease()

GHOST_TSuccess GHOST_ContextSDL::swapBufferRelease ( )

overridevirtual

Swaps front and back buffers of a window.

Returns

A boolean success indicator.

Implements GHOST_Context.

Definition at line 64 of file GHOST_ContextSDL.cc.

References GHOST_kSuccess.

---

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

• GHOST_ContextSDL.hh
• GHOST_ContextSDL.cc