GHOST_ContextCGL Class Reference

#include <GHOST_ContextCGL.h>

Inherits GHOST_Context.

Public Member Functions
	GHOST_ContextCGL (bool stereoVisual, NSView *metalView, CAMetalLayer *metalLayer, NSOpenGLView *openglView)
	~GHOST_ContextCGL ()
GHOST_TSuccess	swapBuffers ()
GHOST_TSuccess	activateDrawingContext ()
GHOST_TSuccess	releaseDrawingContext ()
unsigned int	getDefaultFramebuffer ()
GHOST_TSuccess	initializeDrawingContext ()
GHOST_TSuccess	releaseNativeHandles ()
GHOST_TSuccess	setSwapInterval (int interval)
GHOST_TSuccess	getSwapInterval (int &)
GHOST_TSuccess	updateDrawingContext ()
Public Member Functions inherited from GHOST_Context
	GHOST_Context (bool stereoVisual)
virtual	~GHOST_Context ()
bool	isStereoVisual () const
virtual bool	isUpsideDown () const
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

Detailed Description

Definition at line 36 of file GHOST_ContextCGL.h.

Constructor & Destructor Documentation

GHOST_ContextCGL()

GHOST_ContextCGL::GHOST_ContextCGL	(	bool	stereoVisual,
		NSView *	metalView,
		CAMetalLayer *	metalLayer,
		NSOpenGLView *	openglView
	)

Constructor.

Definition at line 56 of file GHOST_ContextCGL.mm.

~GHOST_ContextCGL()

GHOST_ContextCGL::~GHOST_ContextCGL

(

)

Destructor.

Definition at line 82 of file GHOST_ContextCGL.mm.

Member Function Documentation

activateDrawingContext()

GHOST_TSuccess GHOST_ContextCGL::activateDrawingContext ( )

virtual

Activates the drawing context of this window.

Returns

A boolean success indicator.

Implements GHOST_Context.

Definition at line 159 of file GHOST_ContextCGL.mm.

References GHOST_kFailure, GHOST_kSuccess, init, and blender::compositor::pool.

getDefaultFramebuffer()

unsigned int GHOST_ContextCGL::getDefaultFramebuffer ( )

virtual

Gets the OpenGL frame-buffer associated with the OpenGL context

Returns

The ID of an OpenGL frame-buffer object.

Reimplemented from GHOST_Context.

Definition at line 185 of file GHOST_ContextCGL.mm.

getSwapInterval()

GHOST_TSuccess GHOST_ContextCGL::getSwapInterval ( int &  intervalOut )

virtual

Gets the current swap interval for swapBuffers.

Parameters

intervalOut

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 139 of file GHOST_ContextCGL.mm.

References GHOST_kFailure, GHOST_kSuccess, init, and blender::compositor::pool.

initializeDrawingContext()

GHOST_TSuccess GHOST_ContextCGL::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 243 of file GHOST_ContextCGL.mm.

References error(), GHOST_kFailure, GHOST_kSuccess, init, GHOST_Context::initClearGL(), GHOST_Context::initContextGLEW(), GHOST_Context::m_stereoVisual, makeAttribList(), and blender::compositor::pool.

releaseDrawingContext()

GHOST_TSuccess GHOST_ContextCGL::releaseDrawingContext ( )

virtual

Release the drawing context of the calling thread.

Returns

A boolean success indicator.

Implements GHOST_Context.

Definition at line 172 of file GHOST_ContextCGL.mm.

References GHOST_kFailure, GHOST_kSuccess, init, and blender::compositor::pool.

releaseNativeHandles()

GHOST_TSuccess GHOST_ContextCGL::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 322 of file GHOST_ContextCGL.mm.

References GHOST_kSuccess.

setSwapInterval()

GHOST_TSuccess GHOST_ContextCGL::setSwapInterval ( int  interval )

virtual

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 126 of file GHOST_ContextCGL.mm.

References GHOST_kFailure, GHOST_kSuccess, init, and blender::compositor::pool.

swapBuffers()

GHOST_TSuccess GHOST_ContextCGL::swapBuffers ( )

virtual

Swaps front and back buffers of a window.

Returns

A boolean success indicator.

Implements GHOST_Context.

Definition at line 108 of file GHOST_ContextCGL.mm.

References GHOST_kFailure, GHOST_kSuccess, init, and blender::compositor::pool.

updateDrawingContext()

GHOST_TSuccess GHOST_ContextCGL::updateDrawingContext ( )

virtual

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

Returns

Indication of success.

Reimplemented from GHOST_Context.

Definition at line 190 of file GHOST_ContextCGL.mm.

References GHOST_kFailure, GHOST_kSuccess, init, blender::compositor::pool, and update().

---

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

• GHOST_ContextCGL.h
• GHOST_ContextCGL.mm