candlewick::RenderContext Struct Reference

The RenderContext class provides a rendering context for a graphical application. More...

#include <candlewick/core/RenderContext.h>

Public Member Functions
	RenderContext (NoInitT)
	RenderContext (Device &&device, Window &&window)
	Constructor without a depth format.
	RenderContext (Device &&device, Window &&window, SDL_GPUTextureFormat suggested_depth_format)
	Constructor with a depth format. This will create a depth texture.
void	createDepthTexture (SDL_GPUTextureFormat suggested_depth_format)
	Add a depth texture to the rendering context.
bool	initialized () const
CommandBuffer	acquireCommandBuffer () const
	Acquire the command buffer, starting a frame.
bool	waitAndAcquireSwapchain (CommandBuffer &command_buffer)
	Wait until swapchain is available, then acquire it.
bool	acquireSwapchain (CommandBuffer &command_buffer)
	Acquire GPU swapchain.
bool	waitForSwapchain ()
SDL_GPUTextureFormat	getSwapchainTextureFormat () const
bool	hasDepthTexture () const
	Check if a depth texture was created.
SDL_GPUTextureFormat	depthFormat () const
	~RenderContext () noexcept
void	destroy () noexcept

Public Attributes
Device	device
Window	window
SDL_GPUTexture *	swapchain
Texture	depth_texture {NoInit}

Detailed Description

The RenderContext class provides a rendering context for a graphical application.

See also

Scene

Device

Mesh

Constructor & Destructor Documentation

RenderContext() [1/3]

candlewick::RenderContext::RenderContext ( NoInitT )

inline

RenderContext() [2/3]

candlewick::RenderContext::RenderContext	(	Device &&	device,
		Window &&	window )

Constructor without a depth format.

RenderContext() [3/3]

candlewick::RenderContext::RenderContext	(	Device &&	device,
		Window &&	window,
		SDL_GPUTextureFormat	suggested_depth_format )

Constructor with a depth format. This will create a depth texture.

~RenderContext()

candlewick::RenderContext::~RenderContext ( )

noexcept

Member Function Documentation

acquireCommandBuffer()

CommandBuffer candlewick::RenderContext::acquireCommandBuffer ( ) const

inline

Acquire the command buffer, starting a frame.

acquireSwapchain()

bool candlewick::RenderContext::acquireSwapchain

(

CommandBuffer &

command_buffer

)

Acquire GPU swapchain.

Warning

This can only be called from the main thread (see SDL docs for the meaning of "main thread").

createDepthTexture()

void candlewick::RenderContext::createDepthTexture

(

SDL_GPUTextureFormat

suggested_depth_format

)

Add a depth texture to the rendering context.

See also

hasDepthTexture()

depthFormat()

SDL_GPUTextureFormat candlewick::RenderContext::depthFormat ( ) const

inline

destroy()

void candlewick::RenderContext::destroy ( )

inlinenoexcept

getSwapchainTextureFormat()

SDL_GPUTextureFormat candlewick::RenderContext::getSwapchainTextureFormat ( ) const

inline

hasDepthTexture()

bool candlewick::RenderContext::hasDepthTexture ( ) const

inline

Check if a depth texture was created.

initialized()

bool candlewick::RenderContext::initialized ( ) const

inline

waitAndAcquireSwapchain()

bool candlewick::RenderContext::waitAndAcquireSwapchain

(

CommandBuffer &

command_buffer

)

Wait until swapchain is available, then acquire it.

See also

acquireSwapchain()

waitForSwapchain()

bool candlewick::RenderContext::waitForSwapchain ( )

inline

Member Data Documentation

depth_texture

Texture candlewick::RenderContext::depth_texture {NoInit}

device

Device candlewick::RenderContext::device

swapchain

SDL_GPUTexture* candlewick::RenderContext::swapchain

window

Window candlewick::RenderContext::window

---

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

• src/candlewick/core/RenderContext.h