Rendering Context. More...

#include <RenderContext.hpp>

Inheritance diagram for gamp::render::RenderContext:

Collaboration diagram for gamp::render::RenderContext:

Classes
struct	Private

Public Member Functions
	RenderContext (Private) noexcept
	Private: Create an invalid instance.

	RenderContext (Private, gamp::handle_t context, RenderContextFlags contextFlags, const jau::util::VersionNumber &version) noexcept
	Private: Create an instance.

virtual	~RenderContext () noexcept=default

AttachableRef	attachObject (std::string_view key, const AttachableRef &obj)
	Attaches user object for the given name, overwrites old mapping if exists.

const gamp::wt::SurfaceRef &	boundSurface () const noexcept

void	clearAttachedObjects ()
	Clears the attachment map.

constexpr gamp::handle_t	context () const noexcept

constexpr RenderContextFlags	contextFlags () const noexcept

AttachableRef	detachObject (std::string_view key)
	Removes attached object if exists and returns it, otherwise returns nullptr.

virtual void	dispose () noexcept

virtual void	disposedNotify ()

AttachableRef	getAttachedObject (std::string_view key) const
	Returns the attached user object for the given name.

constexpr bool	isValid () const noexcept

virtual bool	makeCurrent (const gamp::wt::SurfaceRef &s) noexcept
	Make this context current (used for OpenGL, but a NOP on Vulkan)

virtual void	releaseContext () noexcept
	Release this context (used for OpenGL, but a NOP on Vulkan)

virtual const RenderProfile &	renderProfile () const noexcept

virtual const jau::type_info &	signature () const noexcept

virtual std::string	toString () const

constexpr const jau::util::VersionNumber &	version () const

Protected Attributes
gamp::wt::SurfaceRef	m_surface

Detailed Description

Rendering Context.

Definition at line 112 of file RenderContext.hpp.

Constructor & Destructor Documentation

◆ RenderContext() [1/2]

gamp::render::RenderContext::RenderContext ( Private )

inlinenoexcept

Private: Create an invalid instance.

Definition at line 125 of file RenderContext.hpp.

Here is the caller graph for this function:

◆ RenderContext() [2/2]

gamp::render::RenderContext::RenderContext	(	Private	,
		gamp::handle_t	context,
		RenderContextFlags	contextFlags,
		const jau::util::VersionNumber &	version )

inlinenoexcept

Private: Create an instance.

Given profile tag must be a valid implementation profile.

Definition at line 129 of file RenderContext.hpp.

◆ ~RenderContext()

virtual gamp::render::RenderContext::~RenderContext ( )

virtualdefaultnoexcept

Member Function Documentation

◆ signature()

virtual const jau::type_info & gamp::render::RenderContext::signature ( ) const

inlinevirtualnoexcept

Reimplemented in gamp::render::gl::GLContext.

Definition at line 136 of file RenderContext.hpp.

Here is the caller graph for this function:

◆ renderProfile()

virtual const RenderProfile & gamp::render::RenderContext::renderProfile ( ) const

inlinevirtualnoexcept

Reimplemented in gamp::render::gl::GLContext.

Definition at line 138 of file RenderContext.hpp.

◆ isValid()

bool gamp::render::RenderContext::isValid ( ) const

inlineconstexprnoexcept

Definition at line 140 of file RenderContext.hpp.

Here is the caller graph for this function:

◆ context()

gamp::handle_t gamp::render::RenderContext::context ( ) const

inlineconstexprnoexcept

Definition at line 141 of file RenderContext.hpp.

Here is the caller graph for this function:

◆ version()

const jau::util::VersionNumber & gamp::render::RenderContext::version ( ) const

inlineconstexpr

Definition at line 142 of file RenderContext.hpp.

Here is the caller graph for this function:

◆ contextFlags()

RenderContextFlags gamp::render::RenderContext::contextFlags ( ) const

inlineconstexprnoexcept

Definition at line 144 of file RenderContext.hpp.

Here is the caller graph for this function:

◆ dispose()

virtual void gamp::render::RenderContext::dispose ( )

inlinevirtualnoexcept

Reimplemented in gamp::render::gl::GLContext.

Definition at line 146 of file RenderContext.hpp.

◆ disposedNotify()

virtual void gamp::render::RenderContext::disposedNotify ( )

inlinevirtual

Reimplemented in gamp::render::gl::GLContext.

Definition at line 148 of file RenderContext.hpp.

Here is the caller graph for this function:

◆ makeCurrent()

virtual bool gamp::render::RenderContext::makeCurrent ( const gamp::wt::SurfaceRef & s )

inlinevirtualnoexcept

Make this context current (used for OpenGL, but a NOP on Vulkan)

Reimplemented in gamp::render::gl::GLContext.

Definition at line 156 of file RenderContext.hpp.

Here is the caller graph for this function:

◆ releaseContext()

virtual void gamp::render::RenderContext::releaseContext ( )

inlinevirtualnoexcept

Release this context (used for OpenGL, but a NOP on Vulkan)

Reimplemented in gamp::render::gl::GLContext.

Definition at line 158 of file RenderContext.hpp.

Here is the caller graph for this function:

◆ boundSurface()

const gamp::wt::SurfaceRef & gamp::render::RenderContext::boundSurface ( ) const

inlinenoexcept

Definition at line 159 of file RenderContext.hpp.

◆ getAttachedObject()

AttachableRef gamp::render::RenderContext::getAttachedObject ( std::string_view key ) const

inline

Returns the attached user object for the given name.

Definition at line 162 of file RenderContext.hpp.

◆ clearAttachedObjects()

void gamp::render::RenderContext::clearAttachedObjects ( )

inline

Clears the attachment map.

Definition at line 165 of file RenderContext.hpp.

Here is the caller graph for this function:

◆ attachObject()

AttachableRef gamp::render::RenderContext::attachObject	(	std::string_view	key,
		const AttachableRef &	obj )

inline

Attaches user object for the given name, overwrites old mapping if exists.

Returns: previously set object or nullptr.

Definition at line 171 of file RenderContext.hpp.

◆ detachObject()

AttachableRef gamp::render::RenderContext::detachObject ( std::string_view key )

inline

Removes attached object if exists and returns it, otherwise returns nullptr.

Definition at line 174 of file RenderContext.hpp.

◆ toString()

std::string gamp::render::RenderContext::toString ( ) const

virtual

Reimplemented in gamp::render::gl::GLContext.

Definition at line 62 of file gamp.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ m_surface

gamp::wt::SurfaceRef gamp::render::RenderContext::m_surface

protected

Definition at line 121 of file RenderContext.hpp.

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

include/gamp/render/RenderContext.hpp
src/gamp.cpp

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RenderContext() [1/2]

◆ RenderContext() [2/2]

◆ ~RenderContext()

Member Function Documentation

◆ signature()

◆ renderProfile()

◆ isValid()

◆ context()

◆ version()

◆ contextFlags()

◆ dispose()

◆ disposedNotify()

◆ makeCurrent()

◆ releaseContext()

◆ boundSurface()

◆ getAttachedObject()

◆ clearAttachedObjects()

◆ attachObject()

◆ detachObject()

◆ toString()

Member Data Documentation

◆ m_surface