candlewick::media Namespace Reference

Classes
struct	DownloadResult
class	TransferBufferPool
	Transfer buffer for the texture downloader. More...
class	VideoRecorder

Functions
DownloadResult	downloadTexture (CommandBuffer &command_buffer, const Device &device, TransferBufferPool &pool, SDL_GPUTexture *texture, SDL_GPUTextureFormat format, const Uint16 width, const Uint16 height)
	Download texture to a mapped buffer.
void	saveTextureToFile (CommandBuffer &command_buffer, const Device &device, TransferBufferPool &pool, SDL_GPUTexture *texture, SDL_GPUTextureFormat format, const Uint16 width, const Uint16 height, std::string_view filename)

Function Documentation

downloadTexture()

DownloadResult candlewick::media::downloadTexture	(	CommandBuffer &	command_buffer,
		const Device &	device,
		TransferBufferPool &	pool,
		SDL_GPUTexture *	texture,
		SDL_GPUTextureFormat	format,
		const Uint16	width,
		const Uint16	height )

Download texture to a mapped buffer.

Warning

The user is expected to unmap the buffer in the result struct.

Calling this function will submit the provided command buffer.

saveTextureToFile()

void candlewick::media::saveTextureToFile	(	CommandBuffer &	command_buffer,
		const Device &	device,
		TransferBufferPool &	pool,
		SDL_GPUTexture *	texture,
		SDL_GPUTextureFormat	format,
		const Uint16	width,
		const Uint16	height,
		std::string_view	filename )