SDL::GLContext Struct Reference

Handle to an owned gLContext. More...

Inheritance diagram for SDL::GLContext:

Public Member Functions
void	Destroy ()
	Delete an OpenGL context.
GLContextShared	share ()
	Move this gLContext into a GLContextShared.
constexpr	ResourceUnique (std::nullptr_t=nullptr)
	Default constructor.
constexpr	ResourceUnique (base::value_type value, DELETER deleter={})
	Constructs from raw type.
constexpr	ResourceUnique (ResourceUnique &&other)
	Move constructor.
	ResourceUnique (const ResourceUnique &other)=delete
Public Member Functions inherited from SDL::ResourceUnique< GLContextRef >
constexpr	ResourceUnique (std::nullptr_t=nullptr)
	Default constructor.
constexpr	ResourceUnique (base::value_type value, DefaultDeleter< GLContextRef > deleter={})
	Constructs from raw type.
constexpr	ResourceUnique (ResourceUnique &&other)
	Move constructor.
	ResourceUnique (const ResourceUnique &other)=delete
	~ResourceUnique ()
	Destructor.
constexpr ResourceUnique &	operator= (ResourceUnique other)
	Assignment operator.
void	reset ()
	Resets the value, destroying the resource if not nullptr.
Public Member Functions inherited from SDL::ResourceOwnerBase< RESOURCE, DELETER >
RESOURCE	release ()
	Returns reference and reset this.
Public Member Functions inherited from SDL::ResourcePtrBase< RESOURCE >
constexpr	operator bool () const
	Check if not null.
constexpr bool	operator== (const ResourcePtrBase &other) const
	Comparison.
constexpr bool	operator== (std::nullptr_t) const
	Comparison.
constexpr bool	operator== (std::nullopt_t) const
	Comparison.
constexpr reference	operator* () const
	Gets reference.
constexpr const reference *	operator-> () const
	Gets addressable reference.
constexpr reference *	operator-> ()
	Gets addressable reference.
reference	get () const
	Get reference.

Static Public Member Functions
static GLContext	Create (WindowRef window)
	Create an OpenGL context for an OpenGL window, and make it current.

Additional Inherited Members
Public Types inherited from SDL::ResourceOwnerBase< RESOURCE, DELETER >
using	deleter = DELETER
	The deleter type.
Public Types inherited from SDL::ResourcePtrBase< RESOURCE >
using	reference = RESOURCE
	The reference resource type.
using	value_type = typename reference::value_type
	The raw resource type.
Protected Member Functions inherited from SDL::ResourceOwnerBase< RESOURCE, DELETER >
constexpr	ResourceOwnerBase (base::value_type value={}, DELETER deleter={})
	Constructs from raw type.
void	free ()
	Frees resource.
Protected Member Functions inherited from SDL::ResourcePtrBase< RESOURCE >
constexpr	ResourcePtrBase (value_type value={})
	Constructs from raw type.
reference &	get ()
	Get reference.

Detailed Description

Category:

Resource

See also

GLContextRef

Member Function Documentation

Create()

static GLContext SDL::GLContext::Create ( WindowRef  window )

inlinestatic

Windows users new to OpenGL should note that, for historical reasons, GL functions added after OpenGL version 1.1 are not available by default. Those functions must be loaded at run-time, either with an OpenGL extension-handling library or with GL_GetProcAddress() and its related functions.

GLContextRef is opaque to the application.

Parameters

window

the window to associate with the context.

Returns

the OpenGL context associated with window.

Exceptions

Error

on failure.

Thread safety:

This function should only be called on the main thread.

Since

This function is available since SDL 3.2.0.

See also

GLContext.Destroy

GLContextRef.MakeCurrent

Destroy()

void SDL::GLContext::Destroy ( )

inline

Exceptions

Error

on failure.

Thread safety:

This function should only be called on the main thread.

Since

This function is available since SDL 3.2.0.

See also

GLContext.Create

---

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

• SDL3pp/SDL3pp_video.h