1#ifndef SDL3PP_RENDER_H_
2#define SDL3PP_RENDER_H_
4#include <SDL3/SDL_render.h>
5#include "SDL3pp_blendmode.h"
6#include "SDL3pp_events.h"
8#include "SDL3pp_pixels.h"
9#include "SDL3pp_video.h"
68#if SDL_VERSION_ATLEAST(3, 3, 6)
101#if SDL_VERSION_ATLEAST(3, 4, 0)
127 SDL_TEXTUREACCESS_STATIC;
130 SDL_TEXTUREACCESS_STREAMING;
133 SDL_TEXTUREACCESS_TARGET;
135#if SDL_VERSION_ATLEAST(3, 4, 0)
151 SDL_TEXTURE_ADDRESS_INVALID;
163 SDL_TEXTURE_ADDRESS_WRAP;
175 SDL_LOGICAL_PRESENTATION_DISABLED;
179 SDL_LOGICAL_PRESENTATION_STRETCH;
186 SDL_LOGICAL_PRESENTATION_LETTERBOX;
193 SDL_LOGICAL_PRESENTATION_OVERSCAN;
200 SDL_LOGICAL_PRESENTATION_INTEGER_SCALE;
202#if SDL_VERSION_ATLEAST(3, 4, 0)
238#if SDL_VERSION_ATLEAST(3, 4, 0)
1093 void GetScale(
float* scaleX,
float* scaleY)
const;
1479 FlipMode flip = FlipMode::SDL_FLIP_NONE);
1575 float bottom_height,
1579#if SDL_VERSION_ATLEAST(3, 4, 0)
1620 float bottom_height,
1647 std::span<const Vertex> vertices,
1648 std::span<const int> indices = {});
1685 const void* indices,
1689#if SDL_VERSION_ATLEAST(3, 4, 0)
1901 Sint64 signal_semaphore);
2004 template<
class... ARGS>
2006 std::string_view fmt,
2009#if SDL_VERSION_ATLEAST(3, 4, 0)
2091 using RendererBase::RendererBase;
2388 void GetSize(
float* w,
float* h)
const;
2405#if SDL_VERSION_ATLEAST(3, 4, 0)
2850 const Uint8* Yplane,
2852 const Uint8* Uplane,
2854 const Uint8* Vplane,
2882 const Uint8* Yplane,
2884 const Uint8* UVplane,
3000 using TextureBase::TextureBase;
3285 ++resource->refcount;
3304 if (
get() != other.
get()) {
3372 : m_lock(std::move(other.m_lock))
3400 std::swap(m_lock, other.m_lock);
3405 constexpr operator bool()
const {
return bool(m_lock); }
3501 , m_lock(std::move(other.m_lock))
3529 std::swap(m_lock, other.m_lock);
3601 return SDL_GetRenderDriver(index);
3629 title, size.x, size.y, window_flags, window, renderer));
3655 SDL_Window* windowRaw =
nullptr;
3656 SDL_Renderer* rendererRaw =
nullptr;
3658 title, size, window_flags, &windowRaw, &rendererRaw);
3659 if (window) *window =
Window{windowRaw};
3660 if (renderer) *renderer =
Renderer{rendererRaw};
3729 :
Renderer(SDL_CreateRenderer(window, name))
3734 :
Renderer(SDL_CreateRendererWithProperties(props))
3739 :
Renderer(SDL_CreateSoftwareRenderer(surface))
3818 SDL_PROP_RENDERER_CREATE_NAME_STRING;
3821 SDL_PROP_RENDERER_CREATE_WINDOW_POINTER;
3824 SDL_PROP_RENDERER_CREATE_SURFACE_POINTER;
3827 SDL_PROP_RENDERER_CREATE_OUTPUT_COLORSPACE_NUMBER;
3831 SDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_NUMBER;
3833#if SDL_VERSION_ATLEAST(3, 4, 0)
3836 SDL_PROP_RENDERER_CREATE_GPU_DEVICE_POINTER;
3839 SDL_PROP_RENDERER_CREATE_GPU_SHADERS_SPIRV_BOOLEAN;
3843 SDL_PROP_RENDERER_CREATE_GPU_SHADERS_DXIL_BOOLEAN;
3847 SDL_PROP_RENDERER_CREATE_GPU_SHADERS_MSL_BOOLEAN;
3852 SDL_PROP_RENDERER_CREATE_VULKAN_INSTANCE_POINTER;
3856 SDL_PROP_RENDERER_CREATE_VULKAN_SURFACE_NUMBER;
3859 SDL_PROP_RENDERER_CREATE_VULKAN_PHYSICAL_DEVICE_POINTER;
3864 SDL_PROP_RENDERER_CREATE_VULKAN_DEVICE_POINTER;
3867 SDL_PROP_RENDERER_CREATE_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER;
3875 SDL_PROP_RENDERER_CREATE_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER;
3884#if SDL_VERSION_ATLEAST(3, 4, 0)
3920 return SDL_CreateGPURenderer(device, window);
3936 return SDL_GetGPURendererDevice(renderer);
4004 return CheckError(SDL_GetRenderWindow(renderer));
4028 return CheckError(SDL_GetRendererName(renderer));
4123 return CheckError(SDL_GetRendererProperties(renderer));
4144 SDL_PROP_RENDERER_NAME_STRING;
4147 SDL_PROP_RENDERER_WINDOW_POINTER;
4150 SDL_PROP_RENDERER_SURFACE_POINTER;
4153 SDL_PROP_RENDERER_VSYNC_NUMBER;
4156 SDL_PROP_RENDERER_MAX_TEXTURE_SIZE_NUMBER;
4159 SDL_PROP_RENDERER_TEXTURE_FORMATS_POINTER;
4161#if SDL_VERSION_ATLEAST(3, 4, 0)
4164 SDL_PROP_RENDERER_TEXTURE_WRAPPING_BOOLEAN;
4169 SDL_PROP_RENDERER_OUTPUT_COLORSPACE_NUMBER;
4172 SDL_PROP_RENDERER_HDR_ENABLED_BOOLEAN;
4175 SDL_PROP_RENDERER_SDR_WHITE_POINT_FLOAT;
4178 SDL_PROP_RENDERER_HDR_HEADROOM_FLOAT;
4181 SDL_PROP_RENDERER_D3D9_DEVICE_POINTER;
4184 SDL_PROP_RENDERER_D3D11_DEVICE_POINTER;
4187 SDL_PROP_RENDERER_D3D11_SWAPCHAIN_POINTER;
4190 SDL_PROP_RENDERER_D3D12_DEVICE_POINTER;
4193 SDL_PROP_RENDERER_D3D12_SWAPCHAIN_POINTER;
4196 SDL_PROP_RENDERER_D3D12_COMMAND_QUEUE_POINTER;
4200 SDL_PROP_RENDERER_VULKAN_INSTANCE_POINTER;
4203 SDL_PROP_RENDERER_VULKAN_SURFACE_NUMBER;
4206 SDL_PROP_RENDERER_VULKAN_PHYSICAL_DEVICE_POINTER;
4210 SDL_PROP_RENDERER_VULKAN_DEVICE_POINTER;
4213 SDL_PROP_RENDERER_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER;
4220 SDL_PROP_RENDERER_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER;
4226 SDL_PROP_RENDERER_VULKAN_SWAPCHAIN_IMAGE_COUNT_NUMBER;
4230 SDL_PROP_RENDERER_GPU_DEVICE_POINTER;
4256 CheckError(SDL_GetRenderOutputSize(renderer, w, h));
4317 CheckError(SDL_GetCurrentRenderOutputSize(renderer, w, h));
4383 return Texture(renderer, format, access, size);
4397 :
Texture(SDL_CreateTexture(renderer, format, access, size.x, size.y))
4402 :
Texture(SDL_CreateTextureFromSurface(renderer, surface))
4407 :
Texture(SDL_CreateTextureWithProperties(renderer, props))
4439 return Texture(renderer, surface);
4571 return Texture(renderer, props);
4587 SDL_PROP_TEXTURE_CREATE_COLORSPACE_NUMBER;
4590 SDL_PROP_TEXTURE_CREATE_FORMAT_NUMBER;
4593 SDL_PROP_TEXTURE_CREATE_ACCESS_NUMBER;
4596 SDL_PROP_TEXTURE_CREATE_WIDTH_NUMBER;
4599 SDL_PROP_TEXTURE_CREATE_HEIGHT_NUMBER;
4601#if SDL_VERSION_ATLEAST(3, 4, 0)
4604 SDL_PROP_TEXTURE_CREATE_PALETTE_POINTER;
4609 SDL_PROP_TEXTURE_CREATE_SDR_WHITE_POINT_FLOAT;
4612 SDL_PROP_TEXTURE_CREATE_HDR_HEADROOM_FLOAT;
4615 SDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_POINTER;
4618 SDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_U_POINTER;
4622 SDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_V_POINTER;
4626 SDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_POINTER;
4629 SDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_U_POINTER;
4633 SDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_V_POINTER;
4637 SDL_PROP_TEXTURE_CREATE_METAL_PIXELBUFFER_POINTER;
4641 SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_NUMBER;
4644 SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_UV_NUMBER;
4648 SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_U_NUMBER;
4652 SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_V_NUMBER;
4656 SDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER;
4660 SDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_UV_NUMBER;
4664 SDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_U_NUMBER;
4668 SDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_V_NUMBER;
4672 SDL_PROP_TEXTURE_CREATE_VULKAN_TEXTURE_NUMBER;
4675#if SDL_VERSION_ATLEAST(3, 4, 0)
4678 SDL_PROP_TEXTURE_CREATE_VULKAN_LAYOUT_NUMBER;
4681 SDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_POINTER;
4684 SDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_UV_POINTER;
4688 SDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_U_POINTER;
4691 SDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_V_POINTER;
4794 return CheckError(SDL_GetTextureProperties(texture));
4815 SDL_PROP_TEXTURE_COLORSPACE_NUMBER;
4818 SDL_PROP_TEXTURE_FORMAT_NUMBER;
4821 SDL_PROP_TEXTURE_ACCESS_NUMBER;
4824 SDL_PROP_TEXTURE_WIDTH_NUMBER;
4827 SDL_PROP_TEXTURE_HEIGHT_NUMBER;
4830 SDL_PROP_TEXTURE_SDR_WHITE_POINT_FLOAT;
4833 SDL_PROP_TEXTURE_HDR_HEADROOM_FLOAT;
4836 SDL_PROP_TEXTURE_D3D11_TEXTURE_POINTER;
4839 SDL_PROP_TEXTURE_D3D11_TEXTURE_U_POINTER;
4842 SDL_PROP_TEXTURE_D3D11_TEXTURE_V_POINTER;
4845 SDL_PROP_TEXTURE_D3D12_TEXTURE_POINTER;
4848 SDL_PROP_TEXTURE_D3D12_TEXTURE_U_POINTER;
4851 SDL_PROP_TEXTURE_D3D12_TEXTURE_V_POINTER;
4854 SDL_PROP_TEXTURE_OPENGL_TEXTURE_NUMBER;
4857 SDL_PROP_TEXTURE_OPENGL_TEXTURE_UV_NUMBER;
4860 SDL_PROP_TEXTURE_OPENGL_TEXTURE_U_NUMBER;
4863 SDL_PROP_TEXTURE_OPENGL_TEXTURE_V_NUMBER;
4866 SDL_PROP_TEXTURE_OPENGL_TEXTURE_TARGET_NUMBER;
4870 SDL_PROP_TEXTURE_OPENGL_TEX_W_FLOAT;
4873 SDL_PROP_TEXTURE_OPENGL_TEX_H_FLOAT;
4876 SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_NUMBER;
4879 SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_UV_NUMBER;
4883 SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_U_NUMBER;
4887 SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_V_NUMBER;
4891 SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_TARGET_NUMBER;
4895 SDL_PROP_TEXTURE_VULKAN_TEXTURE_NUMBER;
4897#if SDL_VERSION_ATLEAST(3, 4, 0)
4900 SDL_PROP_TEXTURE_GPU_TEXTURE_POINTER;
4903 SDL_PROP_TEXTURE_GPU_TEXTURE_UV_POINTER;
4906 SDL_PROP_TEXTURE_GPU_TEXTURE_U_POINTER;
4909 SDL_PROP_TEXTURE_GPU_TEXTURE_V_POINTER;
4928 return CheckError(SDL_GetRendererFromTexture(texture));
4952 CheckError(SDL_GetTextureSize(texture, w, h));
4958 return Point(texture->w, texture->h);
4994 return texture->format;
5002#if SDL_VERSION_ATLEAST(3, 4, 0)
5025 CheckError(SDL_SetTexturePalette(texture, palette));
5083 CheckError(SDL_SetTextureColorMod(texture, r, g, b));
5122 CheckError(SDL_SetTextureColorModFloat(texture, r, g, b));
5152 CheckError(SDL_GetTextureColorMod(texture, r, g, b));
5182 CheckError(SDL_GetTextureColorModFloat(texture, r, g, b));
5215 CheckError(SDL_SetTextureAlphaMod(texture, alpha));
5248 CheckError(SDL_SetTextureAlphaModFloat(texture, alpha));
5274 CheckError(SDL_GetTextureAlphaMod(texture, &alpha));
5301 CheckError(SDL_GetTextureAlphaModFloat(texture, &alpha));
5447 CheckError(SDL_SetTextureBlendMode(texture, blendMode));
5471 CheckError(SDL_GetTextureBlendMode(texture, &blendMode));
5499 CheckError(SDL_SetTextureScaleMode(texture, scaleMode));
5523 CheckError(SDL_GetTextureScaleMode(texture, &scaleMode));
5568 CheckError(SDL_UpdateTexture(texture, rect, pixels, pitch));
5605 UpdateTexture(texture, rect, surface->pixels, surface->pitch);
5648 const Uint8* Yplane,
5650 const Uint8* Uplane,
5652 const Uint8* Vplane,
5656 texture, rect, Yplane, Ypitch, Uplane, Upitch, Vplane, Vpitch));
5660 const Uint8* Yplane,
5662 const Uint8* Uplane,
5664 const Uint8* Vplane,
5668 get(), rect, Yplane, Ypitch, Uplane, Upitch, Vplane, Vpitch);
5697 const Uint8* Yplane,
5699 const Uint8* UVplane,
5703 SDL_UpdateNVTexture(texture, rect, Yplane, Ypitch, UVplane, UVpitch));
5707 const Uint8* Yplane,
5709 const Uint8* UVplane,
5747 CheckError(SDL_LockTexture(texture, rect, pixels, pitch));
5754 return {
TextureRef(*
this), rect, pixels, pitch};
5802 CheckError(SDL_LockTextureToSurface(texture, rect, &surface));
5843 std::move(lock).reset();
5849 std::move(lock).reset();
5854 if (!m_lock)
return;
5861 if (!m_lock)
return;
5892 CheckError(SDL_SetRenderTarget(renderer, texture));
5939 if (
auto texture = SDL_GetRenderTarget(renderer))
5996 CheckError(SDL_SetRenderLogicalPresentation(renderer, size.x, size.y, mode));
6032 CheckError(SDL_GetRenderLogicalPresentation(renderer, w, h, mode));
6104 CheckError(SDL_GetRenderLogicalPresentationRect(renderer, &rect));
6140 renderer, window_coord.x, window_coord.y, &p.x, &p.y));
6178 SDL_RenderCoordinatesToWindow(renderer, coord.x, coord.y, &p.x, &p.y));
6222 CheckError(SDL_ConvertEventToRenderCoordinates(renderer, event));
6257 CheckError(SDL_SetRenderViewport(renderer, rect));
6308 CheckError(SDL_GetRenderViewport(renderer, &rect));
6339 return SDL_RenderViewportSet(renderer);
6368 CheckError(SDL_GetRenderSafeArea(renderer, &rect));
6399 CheckError(SDL_SetRenderClipRect(renderer, rect));
6451 CheckError(SDL_GetRenderClipRect(renderer, &rect));
6479 return SDL_RenderClipEnabled(renderer);
6513 CheckError(SDL_SetRenderScale(renderer, scale.x, scale.y));
6540 CheckError(SDL_GetRenderScale(renderer, scaleX, scaleY));
6594 CheckError(SDL_SetRenderDrawColor(renderer, c.r, c.g, c.b, c.a));
6621 CheckError(SDL_SetRenderDrawColorFloat(renderer, c.r, c.g, c.b, c.a));
6656 CheckError(SDL_GetRenderDrawColor(renderer, r, g, b, a));
6720 CheckError(SDL_GetRenderDrawColorFloat(renderer, r, g, b, a));
6779 CheckError(SDL_SetRenderColorScale(renderer, scale));
6803 CheckError(SDL_GetRenderColorScale(renderer, &scale));
6832 CheckError(SDL_SetRenderDrawBlendMode(renderer, blendMode));
6856 CheckError(SDL_GetRenderDrawBlendMode(renderer, &blendMode));
6904 CheckError(SDL_RenderPoint(renderer, p.x, p.y));
6954 CheckError(SDL_RenderLine(renderer, p1.x, p1.y, p2.x, p2.y));
7053 CheckError(SDL_RenderFillRect(renderer, rect));
7110 CheckError(SDL_RenderTexture(renderer, texture, srcrect, dstrect));
7151 FlipMode flip = FlipMode::SDL_FLIP_NONE)
7154 renderer, texture, srcrect, dstrect, angle, center, flip));
7166 get(), texture, srcrect, dstrect, angle, center, flip);
7202 SDL_RenderTextureAffine(renderer, texture, srcrect, origin, right, down));
7246 SDL_RenderTextureTiled(renderer, texture, srcrect, scale, dstrect));
7296 float bottom_height,
7317 float bottom_height,
7332#if SDL_VERSION_ATLEAST(3, 4, 0)
7375 float bottom_height,
7380 CheckError(SDL_RenderTexture9GridTiled(renderer,
7397 float bottom_height,
7438 std::span<const Vertex> vertices,
7439 std::span<const int> indices = {})
7450 std::span<const Vertex> vertices,
7451 std::span<const int> indices)
7492 const void* indices,
7518 const void* indices,
7536#if SDL_VERSION_ATLEAST(3, 4, 0)
7560 CheckError(SDL_SetRenderTextureAddressMode(renderer, u_mode, v_mode));
7591 CheckError(SDL_GetRenderTextureAddressMode(renderer, u_mode, v_mode));
7628 return Surface{
CheckError(SDL_RenderReadPixels(renderer, rect))};
7722 SDL_DestroyRenderer(renderer);
7782 return SDL_GetRenderMetalLayer(renderer);
7813 return SDL_GetRenderMetalCommandEncoder(renderer);
7853 renderer, wait_stage_mask, wait_semaphore, signal_semaphore));
7861 get(), wait_stage_mask, wait_semaphore, signal_semaphore);
7888 CheckError(SDL_SetRenderVSync(renderer, vsync));
7919 CheckError(SDL_GetRenderVSync(renderer, &vsync));
7935 SDL_DEBUG_TEXT_FONT_CHARACTER_SIZE;
7978 CheckError(SDL_RenderDebugText(renderer, p.x, p.y, str));
8010template<
class... ARGS>
8013 std::string_view fmt,
8017 renderer, p, std::vformat(fmt, std::make_format_args(args...)));
8020template<
class... ARGS>
8022 std::string_view fmt,
8028#if SDL_VERSION_ATLEAST(3, 4, 0)
8048 CheckError(SDL_SetDefaultTextureScaleMode(renderer, scale_mode));
8073 CheckError(SDL_GetDefaultTextureScaleMode(renderer, scale_mode));
8135 using GPURenderStateBase::GPURenderStateBase;
8219 :
GPURenderState(SDL_CreateGPURenderState(renderer, &createinfo))
8246 SDL_SetGPURenderStateFragmentUniforms(state, slot_index, data, length));
8274 CheckError(SDL_SetGPURenderState(renderer, state));
8296 SDL_DestroyGPURenderState(state);
Optional-like shim for references.
Definition SDL3pp_optionalRef.h:20
constexpr RawPointer release() noexcept
Definition SDL3pp_resource.h:57
friend constexpr void swap(ResourceBaseT &lhs, ResourceBaseT &rhs) noexcept
Definition SDL3pp_resource.h:65
constexpr RawPointer get() const noexcept
Definition SDL3pp_resource.h:54
constexpr ResourceBaseT()=default
Default constructor, creates null/invalid resource.
Const reference wrapper for a given resource,.
Definition SDL3pp_resource.h:115
span-like for empty-derived structs
Definition SDL3pp_spanRef.h:24
constexpr T * data() const
Retrieves contained data.
Definition SDL3pp_spanRef.h:75
constexpr size_t size() const
Retrieves contained size.
Definition SDL3pp_spanRef.h:69
Helpers to use C++ strings parameters.
Definition SDL3pp_strings.h:58
Lock a portion of the texture for write-only pixel access.
Definition SDL3pp_render.h:3329
TextureRef resource() const
Get the reference to locked resource.
Definition SDL3pp_render.h:3427
~TextureLock()
Unlock a texture, uploading the changes to video memory, if needed.
Definition SDL3pp_render.h:3393
TextureLock & operator=(TextureLock &&other) noexcept
Assignment operator.
Definition SDL3pp_render.h:3398
TextureLock(const TextureLock &other)=delete
Copy constructor.
TextureLock(TextureLock &&other) noexcept
Move constructor.
Definition SDL3pp_render.h:3371
void release()
Releases the lock without unlocking.
Definition SDL3pp_render.h:3430
Lock a portion of the texture for write-only pixel access, and expose it as a SDL surface.
Definition SDL3pp_render.h:3456
~TextureSurfaceLock()
Unlock a texture, uploading the changes to video memory, if needed.
Definition SDL3pp_render.h:3522
TextureSurfaceLock(TextureSurfaceLock &&other) noexcept
Move constructor.
Definition SDL3pp_render.h:3499
TextureRef resource() const
Get the reference to locked resource.
Definition SDL3pp_render.h:3554
TextureSurfaceLock(const TextureSurfaceLock &other)=delete
Copy constructor.
TextureSurfaceLock & operator=(TextureSurfaceLock &&other) noexcept
Assignment operator.
Definition SDL3pp_render.h:3527
#define SDL_assert_paranoid(condition)
An assertion test that is performed only when built with paranoid settings.
Definition SDL3pp_assert.h:383
Uint32 BlendMode
A set of blend modes used in drawing operations.
Definition SDL3pp_blendmode.h:35
constexpr void CheckError(bool result)
Check and throw if returned value from SDL is an error.
Definition SDL3pp_error.h:199
SDL_Event Event
The structure for all events in SDL.
Definition SDL3pp_events.h:844
ResourceRefT< GPUDeviceBase > GPUDeviceRef
Reference for GPUDevice.
Definition SDL3pp_gpu.h:387
ResourceRefT< IOStreamBase > IOStreamRef
Reference for IOStream.
Definition SDL3pp_iostream.h:37
SDL_Color ColorRaw
Alias to raw representation for Color.
Definition SDL3pp_pixels.h:83
SDL_FColor FColorRaw
Alias to raw representation for FColor.
Definition SDL3pp_pixels.h:89
ResourceRefT< PaletteBase > PaletteRef
Reference for Palette.
Definition SDL3pp_pixels.h:111
ResourceRefT< PropertiesBase > PropertiesRef
Reference for Properties.
Definition SDL3pp_properties.h:55
SDL_FRect FRectRaw
Alias to raw representation for FRect.
Definition SDL3pp_rect.h:40
SDL_FPoint FPointRaw
Alias to raw representation for FPoint.
Definition SDL3pp_rect.h:28
SDL_Point PointRaw
Alias to raw representation for Point.
Definition SDL3pp_rect.h:22
void GetColorModFloat(float *r, float *g, float *b) const
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5185
FPoint RenderCoordinatesFromWindow(RendererRef renderer, const FPointRaw &window_coord)
Get a point in render coordinates when given a point in window coordinates.
Definition SDL3pp_render.h:6135
void reset()
Unlock a texture, uploading the changes to video memory, if needed.
Definition SDL3pp_render.h:5859
void UpdateTexture(TextureRef texture, OptionalRef< const RectRaw > rect, const void *pixels, int pitch)
Update the given texture rectangle with new pixel data.
Definition SDL3pp_render.h:5563
RendererRef GetRenderer() const
Get the renderer associated with a window.
Definition SDL3pp_render.h:3986
constexpr TextureAddressMode TEXTURE_ADDRESS_AUTO
Wrapping is enabled if texture coordinates are outside [0, 1], this is the default.
Definition SDL3pp_render.h:157
void SetAlphaMod(Uint8 alpha)
Set an additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5218
void SetDrawBlendMode(BlendMode blendMode)
Set the blend mode used for drawing operations.
Definition SDL3pp_render.h:6835
void ResetTarget()
Set target texture back to window.
Definition SDL3pp_render.h:5920
void GetRenderScale(RendererRef renderer, float *scaleX, float *scaleY)
Get the drawing scale for the current target.
Definition SDL3pp_render.h:6538
constexpr int RENDERER_VSYNC_DISABLED
Constant for disabling renderer vsync.
Definition SDL3pp_render.h:7897
SDL_Vertex Vertex
Vertex structure.
Definition SDL3pp_render.h:117
FRect GetLogicalPresentationRect() const
Get the final presentation rectangle for rendering.
Definition SDL3pp_render.h:6108
void RenderTexture9Grid(RendererRef renderer, TextureRef texture, OptionalRef< const FRectRaw > srcrect, float left_width, float right_width, float top_height, float bottom_height, float scale, OptionalRef< const FRectRaw > dstrect)
Perform a scaled copy using the 9-grid algorithm to the current rendering target at subpixel precisio...
Definition SDL3pp_render.h:7290
void GetRenderTextureAddressMode(TextureAddressMode *u_mode, TextureAddressMode *v_mode)
Get the texture addressing mode used in RenderGeometry().
Definition SDL3pp_render.h:7594
void RenderRects(RendererRef renderer, SpanRef< const FRectRaw > rects)
Draw some number of rectangles on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:7025
void RenderTexture(TextureRef texture, OptionalRef< const FRectRaw > srcrect, OptionalRef< const FRectRaw > dstrect)
Copy a portion of the texture to the current rendering target at subpixel precision.
Definition SDL3pp_render.h:7113
void ResetRenderViewport(RendererRef renderer)
Reset the drawing area for rendering to the entire target.
Definition SDL3pp_render.h:6281
const SDL_Texture * TextureRawConst
Alias to const raw representation for Texture.
Definition SDL3pp_render.h:56
void RenderGeometryRaw(TextureRef texture, const float *xy, int xy_stride, const FColor *color, int color_stride, const float *uv, int uv_stride, int num_vertices, const void *indices, int num_indices, int size_indices)
Render a list of triangles, optionally using a texture and indices into the vertex arrays Color and a...
Definition SDL3pp_render.h:7510
PropertiesRef GetProperties() const
Get the properties associated with a texture.
Definition SDL3pp_render.h:4797
Texture GetRenderTarget(RendererRef renderer)
Get the current render target.
Definition SDL3pp_render.h:5937
void SetColorModFloat(float r, float g, float b)
Set an additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5125
RendererRef CreateGPURenderer(GPUDeviceRef device, WindowRef window)
Create a 2D GPU rendering context.
Definition SDL3pp_render.h:3918
void Destroy()
Destroy custom GPU render state.
Definition SDL3pp_render.h:8299
Texture CreateTextureWithProperties(PropertiesRef props)
Create a texture for a rendering context with the specified properties.
Definition SDL3pp_render.h:4574
void FlushRenderer(RendererRef renderer)
Force the rendering context to flush any pending commands and state.
Definition SDL3pp_render.h:7757
void RenderFillRects(SpanRef< const FRectRaw > rects)
Fill some number of rectangles on the current rendering target with the drawing color at subpixel pre...
Definition SDL3pp_render.h:7081
void RenderFillRect(OptionalRef< const FRectRaw > rect)
Fill a rectangle on the current rendering target with the drawing color at subpixel precision.
Definition SDL3pp_render.h:7056
GPURenderState CreateGPURenderState(RendererRef renderer, const GPURenderStateCreateInfo &createinfo)
Create custom GPU render state.
Definition SDL3pp_render.h:8203
void SetDefaultTextureScaleMode(RendererRef renderer, ScaleMode scale_mode)
Set default scale mode for new textures for given renderer.
Definition SDL3pp_render.h:8045
Rect GetSafeArea() const
Get the safe area for rendering within the current viewport.
Definition SDL3pp_render.h:6372
void CreateWindowAndRenderer(StringParam title, const PointRaw &size, WindowFlags window_flags, Window *window, Renderer *renderer)
Create a window and default renderer.
Definition SDL3pp_render.h:3649
ScaleMode GetTextureScaleMode(TextureConstRef texture)
Get the scale mode used for texture scale operations.
Definition SDL3pp_render.h:5520
void * GetRenderMetalLayer(RendererRef renderer)
Get the CAMetalLayer associated with the given Metal renderer.
Definition SDL3pp_render.h:7780
void SetClipRect(OptionalRef< const RectRaw > rect)
Set the clip rectangle for rendering on the specified target.
Definition SDL3pp_render.h:6402
void GetRenderOutputSize(RendererRef renderer, int *w, int *h)
Get the output size in pixels of a rendering context.
Definition SDL3pp_render.h:4254
TextureLock Lock(OptionalRef< const RectRaw > rect, void **pixels, int *pitch)
Lock a portion of the texture for write-only pixel access.
Definition SDL3pp_render.h:5750
BlendMode GetTextureBlendMode(TextureConstRef texture)
Get the blend mode used for texture copy operations.
Definition SDL3pp_render.h:5468
void SetRenderTextureAddressMode(RendererRef renderer, TextureAddressMode u_mode, TextureAddressMode v_mode)
Set the texture addressing mode used in RenderGeometry().
Definition SDL3pp_render.h:7556
void RenderTexture9Grid(TextureRef texture, OptionalRef< const FRectRaw > srcrect, float left_width, float right_width, float top_height, float bottom_height, float scale, OptionalRef< const FRectRaw > dstrect)
Perform a scaled copy using the 9-grid algorithm to the current rendering target at subpixel precisio...
Definition SDL3pp_render.h:7311
void SetFragmentUniforms(Uint32 slot_index, const void *data, Uint32 length)
Set fragment shader uniform variables in a custom GPU render state.
Definition SDL3pp_render.h:8249
void CreateWindowAndRendererRaw(StringParam title, const PointRaw &size, WindowFlags window_flags, WindowRaw *window, RendererRaw *renderer)
Create a window and default renderer.
Definition SDL3pp_render.h:3622
void RenderDebugText(RendererRef renderer, const FPointRaw &p, StringParam str)
Draw debug text to an Renderer.
Definition SDL3pp_render.h:7974
void SetColorMod(Uint8 r, Uint8 g, Uint8 b)
Set an additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5086
void RenderFillRects(RendererRef renderer, SpanRef< const FRectRaw > rects)
Fill some number of rectangles on the current rendering target with the drawing color at subpixel pre...
Definition SDL3pp_render.h:7075
void RenderDebugTextFormat(const FPointRaw &p, std::string_view fmt, ARGS... args)
Draw debug text to an Renderer.
Definition SDL3pp_render.h:8021
FColor GetModFloat() const
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5421
ResourceConstRef< TextureRaw, TextureRawConst > TextureConstRef
Safely wrap Texture for non owning const parameters.
Definition SDL3pp_render.h:66
void SetMod(Color c)
Set an additional color and alpha values multiplied into render copy operations.
Definition SDL3pp_render.h:5339
void SetVSync(int vsync)
Toggle VSync of the given renderer.
Definition SDL3pp_render.h:7891
void GetRenderDrawColor(RendererRef renderer, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a)
Get the color used for drawing operations (Rect, Line and Clear).
Definition SDL3pp_render.h:6650
void SetGPURenderState(RendererRef renderer, GPURenderStateRef state)
Set custom GPU render state.
Definition SDL3pp_render.h:8272
void RenderPoint(RendererRef renderer, const FPointRaw &p)
Draw a point on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:6902
constexpr TextureAddressMode TEXTURE_ADDRESS_WRAP
The texture is repeated (tiled).
Definition SDL3pp_render.h:162
void RenderRect(RendererRef renderer, OptionalRef< const FRectRaw > rect)
Draw a rectangle on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:7001
Palette GetTexturePalette(TextureRef texture)
Get the palette used by a texture.
Definition SDL3pp_render.h:5046
void GetDefaultTextureScaleMode(ScaleMode *scale_mode)
Get default texture scale mode of the given renderer.
Definition SDL3pp_render.h:8076
void Flush()
Force the rendering context to flush any pending commands and state.
Definition SDL3pp_render.h:7762
Texture CreateTextureWithProperties(RendererRef renderer, PropertiesRef props)
Create a texture for a rendering context with the specified properties.
Definition SDL3pp_render.h:4568
SDL_TextureAccess TextureAccess
The access pattern allowed for a texture.
Definition SDL3pp_render.h:124
Rect GetRenderSafeArea(RendererRef renderer)
Get the safe area for rendering within the current viewport.
Definition SDL3pp_render.h:6365
void SetViewport(OptionalRef< const RectRaw > rect)
Set the drawing area for rendering on the current target.
Definition SDL3pp_render.h:6260
void UpdateNV(OptionalRef< const RectRaw > rect, const Uint8 *Yplane, int Ypitch, const Uint8 *UVplane, int UVpitch)
Update a rectangle within a planar NV12 or NV21 texture with new pixels.
Definition SDL3pp_render.h:5706
constexpr int RENDERER_VSYNC_ADAPTIVE
Constant for enabling asaptive renderer vsync.
Definition SDL3pp_render.h:7900
Point GetCurrentOutputSize() const
Get the current output size in pixels of a rendering context.
Definition SDL3pp_render.h:4351
int GetTextureWidth(TextureConstRef texture)
Get the width in pixels.
Definition SDL3pp_render.h:4982
PropertiesRef GetRendererProperties(RendererRef renderer)
Get the properties associated with a renderer.
Definition SDL3pp_render.h:4121
constexpr auto SOFTWARE_RENDERER
The name of the software renderer.
Definition SDL3pp_render.h:99
void SetRenderColorScale(RendererRef renderer, float scale)
Set the color scale used for render operations.
Definition SDL3pp_render.h:6777
void GetTextureColorMod(TextureConstRef texture, Uint8 *r, Uint8 *g, Uint8 *b)
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5147
void ConvertEventToRenderCoordinates(Event *event) const
Convert the coordinates in an event to render coordinates.
Definition SDL3pp_render.h:6225
void SetRenderVSync(RendererRef renderer, int vsync)
Toggle VSync of the given renderer.
Definition SDL3pp_render.h:7886
GPUDeviceRef GetGPURendererDevice(RendererRef renderer)
Return the GPU device used by a renderer.
Definition SDL3pp_render.h:3934
bool IsClipEnabled() const
Get whether clipping is enabled on the given render target.
Definition SDL3pp_render.h:6482
void GetRenderLogicalPresentation(RendererRef renderer, int *w, int *h, RendererLogicalPresentation *mode)
Get device independent resolution and presentation mode for rendering.
Definition SDL3pp_render.h:6027
Texture CreateTextureFromSurface(SurfaceRef surface)
Create a texture from an existing surface.
Definition SDL3pp_render.h:4442
void SetTextureModFloat(TextureRef texture, FColor c)
Set an additional color and alpha values multiplied into render copy operations.
Definition SDL3pp_render.h:5364
void RenderLine(const FPointRaw &p1, const FPointRaw &p2)
Draw a line on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:6957
void UpdateYUV(OptionalRef< const RectRaw > rect, const Uint8 *Yplane, int Ypitch, const Uint8 *Uplane, int Upitch, const Uint8 *Vplane, int Vpitch)
Update a rectangle within a planar YV12 or IYUV texture with new pixel data.
Definition SDL3pp_render.h:5659
void RenderTexture9GridTiled(TextureRef texture, const FRectRaw &srcrect, float left_width, float right_width, float top_height, float bottom_height, float scale, const FRectRaw &dstrect, float tileScale)
Perform a scaled copy using the 9-grid algorithm to the current rendering target at subpixel precisio...
Definition SDL3pp_render.h:7392
void SetRenderTextureAddressMode(TextureAddressMode u_mode, TextureAddressMode v_mode)
Set the texture addressing mode used in RenderGeometry().
Definition SDL3pp_render.h:7563
void ResetClipRect()
Reset the clip rectangle for rendering to the entire render target.
Definition SDL3pp_render.h:6428
SDL_GPURenderState * GPURenderStateRaw
Alias to raw representation for GPURenderState.
Definition SDL3pp_render.h:77
void SetScale(const FPointRaw &scale)
Set the drawing scale for rendering on the current target.
Definition SDL3pp_render.h:6516
constexpr TextureAddressMode TEXTURE_ADDRESS_INVALID
TEXTURE_ADDRESS_INVALID.
Definition SDL3pp_render.h:150
void DestroyRenderer(RendererRaw renderer)
Destroy the rendering context for a window and free all associated textures.
Definition SDL3pp_render.h:7720
void GetTextureSize(TextureConstRef texture, float *w, float *h)
Get the size of a texture, as floating point values.
Definition SDL3pp_render.h:4950
void RenderClear()
Clear the current rendering target with the drawing color.
Definition SDL3pp_render.h:6887
Texture CreateTexture(RendererRef renderer, PixelFormat format, TextureAccess access, const PointRaw &size)
Create a texture for a rendering context.
Definition SDL3pp_render.h:4378
void Destroy()
Destroy the specified texture.
Definition SDL3pp_render.h:7705
Surface RenderReadPixels(RendererRef renderer, OptionalRef< const RectRaw > rect={})
Read pixels from the current rendering target.
Definition SDL3pp_render.h:7625
TextureSurfaceLock(TextureRef resource, OptionalRef< const RectRaw > rect=std::nullopt)
Lock a portion of the texture for write-only pixel access, and expose it as a SDL surface.
Definition SDL3pp_render.h:5812
Texture GetTarget() const
Get the current render target.
Definition SDL3pp_render.h:5944
void SetTextureScaleMode(TextureRef texture, ScaleMode scaleMode)
Set the scale mode used for texture scale operations.
Definition SDL3pp_render.h:5497
bool RenderClipEnabled(RendererRef renderer)
Get whether clipping is enabled on the given render target.
Definition SDL3pp_render.h:6477
Color GetDrawColor() const
Get the color used for drawing operations (Rect, Line and Clear).
Definition SDL3pp_render.h:6688
void SetRenderDrawColorFloat(RendererRef renderer, const FColorRaw &c)
Set the color used for drawing operations (Rect, Line and Clear).
Definition SDL3pp_render.h:6619
FColor GetDrawColorFloat() const
Get the color used for drawing operations (Rect, Line and Clear).
Definition SDL3pp_render.h:6752
float GetRenderColorScale(RendererRef renderer)
Get the color scale used for render operations.
Definition SDL3pp_render.h:6800
void RenderRects(SpanRef< const FRectRaw > rects)
Draw some number of rectangles on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:7030
Rect GetClipRect() const
Get the clip rectangle for the current target.
Definition SDL3pp_render.h:6455
Rect GetViewport() const
Get the drawing area for the current target.
Definition SDL3pp_render.h:6312
FRect GetRenderLogicalPresentationRect(RendererRef renderer)
Get the final presentation rectangle for rendering.
Definition SDL3pp_render.h:6101
FPoint GetTextureSizeFloat(TextureConstRef texture)
Get the size of a texture, as floating point values.
Definition SDL3pp_render.h:4969
RendererRef GetRendererFromTexture(TextureConstRef texture)
Get the renderer that created an Texture.
Definition SDL3pp_render.h:4926
void SetRenderDrawBlendMode(RendererRef renderer, BlendMode blendMode)
Set the blend mode used for drawing operations.
Definition SDL3pp_render.h:6830
ResourceRefT< TextureBase > TextureRef
Reference for Texture.
Definition SDL3pp_render.h:63
Palette GetPalette()
Get the palette used by a texture.
Definition SDL3pp_render.h:5051
void RenderRect(OptionalRef< const FRectRaw > rect)
Draw a rectangle on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:7006
GPUDeviceRef GetGPUDevice()
Return the GPU device used by a renderer.
Definition SDL3pp_render.h:3939
void RenderTextureRotated(RendererRef renderer, TextureRef texture, OptionalRef< const FRectRaw > srcrect, OptionalRef< const FRectRaw > dstrect, double angle, OptionalRef< const FPointRaw > center, FlipMode flip=FlipMode::SDL_FLIP_NONE)
Copy a portion of the source texture to the current rendering target, with rotation and flipping,...
Definition SDL3pp_render.h:7145
FPoint GetSizeFloat() const
Get the size of a texture, as floating point values.
Definition SDL3pp_render.h:4976
TextureSurfaceLock LockToSurface(OptionalRef< const RectRaw > rect=std::nullopt)
Lock a portion of the texture for write-only pixel access, and expose it as a SDL surface.
Definition SDL3pp_render.h:5806
void RenderTextureTiled(RendererRef renderer, TextureRef texture, OptionalRef< const FRectRaw > srcrect, float scale, OptionalRef< const FRectRaw > dstrect)
Tile a portion of the texture to the current rendering target at subpixel precision.
Definition SDL3pp_render.h:7239
void RenderPoints(SpanRef< const FPointRaw > points)
Draw multiple points on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:6931
void SetTarget(TextureRef texture)
Set a texture as the current rendering target.
Definition SDL3pp_render.h:5895
constexpr RendererLogicalPresentation LOGICAL_PRESENTATION_OVERSCAN
The rendered content is fit to the smallest dimension and the other dimension extends beyond the outp...
Definition SDL3pp_render.h:192
void GetRenderDrawColorFloat(RendererRef renderer, float *r, float *g, float *b, float *a)
Get the color used for drawing operations (Rect, Line and Clear).
Definition SDL3pp_render.h:6714
constexpr auto GPU_RENDERER
The name of the GPU renderer.
Definition SDL3pp_render.h:108
void SetPalette(PaletteRef palette)
Set the palette used by a texture.
Definition SDL3pp_render.h:5028
void ResetRenderClipRect(RendererRef renderer)
Reset the clip rectangle for rendering to the entire render target.
Definition SDL3pp_render.h:6423
Texture CreateTexture(PixelFormat format, TextureAccess access, const PointRaw &size)
Create a texture for a rendering context.
Definition SDL3pp_render.h:4386
RendererRef GetRenderer(WindowRef window)
Get the renderer associated with a window.
Definition SDL3pp_render.h:3981
void * GetRenderMetalCommandEncoder(RendererRef renderer)
Get the Metal command encoder for the current frame.
Definition SDL3pp_render.h:7811
constexpr RendererLogicalPresentation LOGICAL_PRESENTATION_DISABLED
There is no logical size in effect.
Definition SDL3pp_render.h:174
WindowRef GetWindow()
Get the window associated with a renderer.
Definition SDL3pp_render.h:4007
void RenderDebugText(const FPointRaw &p, StringParam str)
Draw debug text to an Renderer.
Definition SDL3pp_render.h:7981
void UpdateNVTexture(TextureRef texture, OptionalRef< const RectRaw > rect, const Uint8 *Yplane, int Ypitch, const Uint8 *UVplane, int UVpitch)
Update a rectangle within a planar NV12 or NV21 texture with new pixels.
Definition SDL3pp_render.h:5695
FPoint RenderCoordinatesToWindow(const FPointRaw &coord) const
Get a point in window coordinates when given a point in render coordinates.
Definition SDL3pp_render.h:6182
void RenderDebugTextFormat(RendererRef renderer, const FPointRaw &p, std::string_view fmt, ARGS... args)
Draw debug text to an Renderer.
Definition SDL3pp_render.h:8011
int GetVSync() const
Get VSync of the given renderer.
Definition SDL3pp_render.h:7923
constexpr TextureAccess TEXTUREACCESS_TARGET
Texture can be used as a render target.
Definition SDL3pp_render.h:132
void RenderPoints(RendererRef renderer, SpanRef< const FPointRaw > points)
Draw multiple points on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:6925
void DestroyTexture(TextureRaw texture)
Destroy the specified texture.
Definition SDL3pp_render.h:7703
void GetLogicalPresentation(int *w, int *h, RendererLogicalPresentation *mode) const
Get device independent resolution and presentation mode for rendering.
Definition SDL3pp_render.h:6066
FColor GetTextureModFloat(TextureConstRef texture)
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5413
void RenderFillRect(RendererRef renderer, OptionalRef< const FRectRaw > rect)
Fill a rectangle on the current rendering target with the drawing color at subpixel precision.
Definition SDL3pp_render.h:7050
void ResetViewport()
Reset the drawing area for rendering to the entire target.
Definition SDL3pp_render.h:6286
void RenderClear(RendererRef renderer)
Clear the current rendering target with the drawing color.
Definition SDL3pp_render.h:6882
int GetWidth() const
Get the width in pixels.
Definition SDL3pp_render.h:4984
Renderer CreateRenderer(WindowRef window, StringParam name=nullptr)
Create a 2D rendering context for a window.
Definition SDL3pp_render.h:3723
void DestroyGPURenderState(GPURenderStateRaw state)
Destroy custom GPU render state.
Definition SDL3pp_render.h:8294
void SetModFloat(FColor c)
Set an additional color and alpha values multiplied into render copy operations.
Definition SDL3pp_render.h:5370
PixelFormat GetTextureFormat(TextureConstRef texture)
Get the pixel format.
Definition SDL3pp_render.h:4992
float GetAlphaModFloat() const
Get the additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5305
void RenderPoint(const FPointRaw &p)
Draw a point on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:6907
Uint8 GetAlphaMod() const
Get the additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5278
ResourceRefT< GPURenderStateBase > GPURenderStateRef
Reference for GPURenderState.
Definition SDL3pp_render.h:84
void SetGPURenderState(GPURenderStateRef state)
Set custom GPU render state.
Definition SDL3pp_render.h:8277
void Present()
Update the screen with any rendering performed since the previous call.
Definition SDL3pp_render.h:7686
BlendMode GetDrawBlendMode() const
Get the blend mode used for drawing operations.
Definition SDL3pp_render.h:6860
void SetDrawColor(ColorRaw c)
Set the color used for drawing operations.
Definition SDL3pp_render.h:6597
Renderer CreateRendererWithProperties(PropertiesRef props)
Create a 2D rendering context for a window, with the specified properties.
Definition SDL3pp_render.h:3805
void GetColorMod(Uint8 *r, Uint8 *g, Uint8 *b) const
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5155
void UpdateYUVTexture(TextureRef texture, OptionalRef< const RectRaw > rect, const Uint8 *Yplane, int Ypitch, const Uint8 *Uplane, int Upitch, const Uint8 *Vplane, int Vpitch)
Update a rectangle within a planar YV12 or IYUV texture with new pixel data.
Definition SDL3pp_render.h:5646
constexpr TextureAccess TEXTUREACCESS_STATIC
Changes rarely, not lockable.
Definition SDL3pp_render.h:126
ScaleMode GetScaleMode() const
Get the scale mode used for texture scale operations.
Definition SDL3pp_render.h:5527
Rect GetRenderViewport(RendererRef renderer)
Get the drawing area for the current target.
Definition SDL3pp_render.h:6305
constexpr RendererLogicalPresentation LOGICAL_PRESENTATION_INTEGER_SCALE
The rendered content is scaled up by integer multiples to fit the output resolution.
Definition SDL3pp_render.h:199
SDL_GPURenderStateCreateInfo GPURenderStateCreateInfo
A structure specifying the parameters of a GPU render state.
Definition SDL3pp_render.h:211
constexpr TextureAccess TEXTUREACCESS_STREAMING
Changes frequently, lockable.
Definition SDL3pp_render.h:129
BlendMode GetBlendMode() const
Get the blend mode used for texture copy operations.
Definition SDL3pp_render.h:5475
void * GetRenderMetalCommandEncoder()
Get the Metal command encoder for the current frame.
Definition SDL3pp_render.h:7816
void SetDrawColorFloat(const FColorRaw &c)
Set the color used for drawing operations (Rect, Line and Clear).
Definition SDL3pp_render.h:6624
Point GetSize() const
Get the size of a texture.
Definition SDL3pp_render.h:4966
Rect GetRenderClipRect(RendererRef renderer)
Get the clip rectangle for the current target.
Definition SDL3pp_render.h:6448
void SetAlphaModFloat(float alpha)
Set an additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5251
void RenderLine(RendererRef renderer, const FPointRaw &p1, const FPointRaw &p2)
Draw a line on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:6950
void SetRenderLogicalPresentation(RendererRef renderer, const PointRaw &size, RendererLogicalPresentation mode)
Set a device-independent resolution and presentation mode for rendering.
Definition SDL3pp_render.h:5992
Color GetMod() const
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5397
void RenderGeometry(TextureRef texture, std::span< const Vertex > vertices, std::span< const int > indices={})
Render a list of triangles, optionally using a texture and indices into the vertex array Color and al...
Definition SDL3pp_render.h:7449
void reset()
Unlock a texture, uploading the changes to video memory, if needed.
Definition SDL3pp_render.h:5852
void SetTextureColorMod(TextureRef texture, Uint8 r, Uint8 g, Uint8 b)
Set an additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5081
void GetDefaultTextureScaleMode(RendererRef renderer, ScaleMode *scale_mode)
Get default texture scale mode of the given renderer.
Definition SDL3pp_render.h:8070
SDL_RendererLogicalPresentation RendererLogicalPresentation
How the logical size is mapped to the output.
Definition SDL3pp_render.h:172
SDL_TextureAddressMode TextureAddressMode
The addressing mode for a texture when used in RenderGeometry().
Definition SDL3pp_render.h:148
float GetColorScale() const
Get the color scale used for render operations.
Definition SDL3pp_render.h:6807
void SetRenderTarget(RendererRef renderer, TextureRef texture)
Set a texture as the current rendering target.
Definition SDL3pp_render.h:5890
int GetRenderVSync(RendererRef renderer)
Get VSync of the given renderer.
Definition SDL3pp_render.h:7916
constexpr int DEBUG_TEXT_FONT_CHARACTER_SIZE
The size, in pixels, of a single RenderDebugText() character.
Definition SDL3pp_render.h:7934
BlendMode GetRenderDrawBlendMode(RendererRef renderer)
Get the blend mode used for drawing operations.
Definition SDL3pp_render.h:6853
PixelFormat GetFormat() const
Get the pixel format.
Definition SDL3pp_render.h:4997
int GetHeight() const
Get the height in pixels.
Definition SDL3pp_render.h:4989
constexpr TextureAddressMode TEXTURE_ADDRESS_CLAMP
Texture coordinates are clamped to the [0, 1] range.
Definition SDL3pp_render.h:160
void Destroy()
Destroy the rendering context for a window and free all associated textures.
Definition SDL3pp_render.h:7725
PropertiesRef GetTextureProperties(TextureConstRef texture)
Get the properties associated with a texture.
Definition SDL3pp_render.h:4792
void SetBlendMode(BlendMode blendMode)
Set the blend mode for a texture, used by RenderTexture().
Definition SDL3pp_render.h:5450
void SetRenderDrawColor(RendererRef renderer, ColorRaw c)
Set the color used for drawing operations.
Definition SDL3pp_render.h:6592
TextureLock(TextureRef resource, OptionalRef< const RectRaw > rect, void **pixels, int *pitch)
Lock a portion of the texture for write-only pixel access.
Definition SDL3pp_render.h:5757
void RenderTextureTiled(TextureRef texture, OptionalRef< const FRectRaw > srcrect, float scale, OptionalRef< const FRectRaw > dstrect)
Tile a portion of the texture to the current rendering target at subpixel precision.
Definition SDL3pp_render.h:7249
FPoint RenderCoordinatesToWindow(RendererRef renderer, const FPointRaw &coord)
Get a point in window coordinates when given a point in render coordinates.
Definition SDL3pp_render.h:6173
void RenderGeometry(RendererRef renderer, TextureRef texture, std::span< const Vertex > vertices, std::span< const int > indices={})
Render a list of triangles, optionally using a texture and indices into the vertex array Color and al...
Definition SDL3pp_render.h:7436
Point GetOutputSize() const
Get the output size in pixels of a rendering context.
Definition SDL3pp_render.h:4290
SDL_Renderer * RendererRaw
Alias to raw representation for Renderer.
Definition SDL3pp_render.h:44
void SetTextureColorModFloat(TextureRef texture, float r, float g, float b)
Set an additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5117
Texture CreateTextureFromSurface(RendererRef renderer, SurfaceRef surface)
Create a texture from an existing surface.
Definition SDL3pp_render.h:4436
SDL_Texture * TextureRaw
Alias to raw representation for Texture.
Definition SDL3pp_render.h:53
constexpr RendererLogicalPresentation LOGICAL_PRESENTATION_LETTERBOX
The rendered content is fit to the largest dimension and the other dimension is letterboxed with the ...
Definition SDL3pp_render.h:185
void RenderLines(SpanRef< const FPointRaw > points)
Draw a series of connected lines on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:6982
void SetTextureAlphaModFloat(TextureRef texture, float alpha)
Set an additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5246
void RenderTexture(RendererRef renderer, TextureRef texture, OptionalRef< const FRectRaw > srcrect, OptionalRef< const FRectRaw > dstrect)
Copy a portion of the texture to the current rendering target at subpixel precision.
Definition SDL3pp_render.h:7105
void AddVulkanRenderSemaphores(Uint32 wait_stage_mask, Sint64 wait_semaphore, Sint64 signal_semaphore)
Add a set of synchronization semaphores for the current frame.
Definition SDL3pp_render.h:7856
void GetRenderTextureAddressMode(RendererRef renderer, TextureAddressMode *u_mode, TextureAddressMode *v_mode)
Get the texture addressing mode used in RenderGeometry().
Definition SDL3pp_render.h:7587
Renderer CreateSoftwareRenderer(SurfaceRef surface)
Create a 2D software rendering context for a surface.
Definition SDL3pp_render.h:3965
const char * GetName() const
Get the name of a renderer.
Definition SDL3pp_render.h:4031
void ConvertEventToRenderCoordinates(RendererRef renderer, Event *event)
Convert the coordinates in an event to render coordinates.
Definition SDL3pp_render.h:6220
Color GetTextureMod(TextureConstRef texture)
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5389
FPoint RenderCoordinatesFromWindow(const FPointRaw &window_coord) const
Get a point in render coordinates when given a point in window coordinates.
Definition SDL3pp_render.h:6144
void RenderGeometryRaw(RendererRef renderer, TextureRef texture, const float *xy, int xy_stride, const FColor *color, int color_stride, const float *uv, int uv_stride, int num_vertices, const void *indices, int num_indices, int size_indices)
Render a list of triangles, optionally using a texture and indices into the vertex arrays Color and a...
Definition SDL3pp_render.h:7483
void SetLogicalPresentation(const PointRaw &size, RendererLogicalPresentation mode)
Set a device-independent resolution and presentation mode for rendering.
Definition SDL3pp_render.h:5999
GPURenderState CreateGPURenderState(const GPURenderStateCreateInfo &createinfo)
Create custom GPU render state.
Definition SDL3pp_render.h:8210
void SetRenderScale(RendererRef renderer, const FPointRaw &scale)
Set the drawing scale for rendering on the current target.
Definition SDL3pp_render.h:6511
void SetRenderViewport(RendererRef renderer, OptionalRef< const RectRaw > rect)
Set the drawing area for rendering on the current target.
Definition SDL3pp_render.h:6254
void RenderPresent(RendererRef renderer)
Update the screen with any rendering performed since the previous call.
Definition SDL3pp_render.h:7681
void SetDefaultTextureScaleMode(ScaleMode scale_mode)
Set default scale mode for new textures for given renderer.
Definition SDL3pp_render.h:8051
void RenderTextureAffine(RendererRef renderer, TextureRef texture, OptionalRef< const FRectRaw > srcrect, OptionalRef< const FPointRaw > origin, OptionalRef< const FPointRaw > right, OptionalRef< const FPointRaw > down)
Copy a portion of the source texture to the current rendering target, with affine transform,...
Definition SDL3pp_render.h:7194
void UnlockTexture(TextureRef texture)
Unlock a texture, uploading the changes to video memory, if needed.
Definition SDL3pp_render.h:5838
void AddVulkanRenderSemaphores(RendererRef renderer, Uint32 wait_stage_mask, Sint64 wait_semaphore, Sint64 signal_semaphore)
Add a set of synchronization semaphores for the current frame.
Definition SDL3pp_render.h:7847
void SetScaleMode(ScaleMode scaleMode)
Set the scale mode used for texture scale operations.
Definition SDL3pp_render.h:5502
constexpr RendererLogicalPresentation LOGICAL_PRESENTATION_STRETCH
The rendered content is stretched to the output resolution.
Definition SDL3pp_render.h:178
const char * GetRendererName(RendererRef renderer)
Get the name of a renderer.
Definition SDL3pp_render.h:4026
FPoint GetScale() const
Get the drawing scale for the current target.
Definition SDL3pp_render.h:6570
void GetCurrentRenderOutputSize(RendererRef renderer, int *w, int *h)
Get the current output size in pixels of a rendering context.
Definition SDL3pp_render.h:4315
float GetTextureAlphaModFloat(TextureConstRef texture)
Get the additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5298
void SetColorScale(float scale)
Set the color scale used for render operations.
Definition SDL3pp_render.h:6782
int GetNumRenderDrivers()
Get the number of 2D rendering drivers available for the current display.
Definition SDL3pp_render.h:3575
const char * GetRenderDriver(int index)
Use this function to get the name of a built in 2D rendering driver.
Definition SDL3pp_render.h:3599
void RenderLines(RendererRef renderer, SpanRef< const FPointRaw > points)
Draw a series of connected lines on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:6976
void RenderTextureAffine(TextureRef texture, OptionalRef< const FRectRaw > srcrect, OptionalRef< const FPointRaw > origin, OptionalRef< const FPointRaw > right, OptionalRef< const FPointRaw > down)
Copy a portion of the source texture to the current rendering target, with affine transform,...
Definition SDL3pp_render.h:7205
WindowRef GetRenderWindow(RendererRef renderer)
Get the window associated with a renderer.
Definition SDL3pp_render.h:4002
void * GetRenderMetalLayer()
Get the CAMetalLayer associated with the given Metal renderer.
Definition SDL3pp_render.h:7785
RendererRef GetRenderer() const
Get the renderer that created an Texture.
Definition SDL3pp_render.h:4931
void Update(OptionalRef< const RectRaw > rect, const void *pixels, int pitch)
Update the given texture rectangle with new pixel data.
Definition SDL3pp_render.h:5608
bool RenderViewportSet(RendererRef renderer)
Return whether an explicit rectangle was set as the viewport.
Definition SDL3pp_render.h:6337
void GetTextureColorModFloat(TextureConstRef texture, float *r, float *g, float *b)
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5177
PropertiesRef GetProperties() const
Get the properties associated with a renderer.
Definition SDL3pp_render.h:4126
void SetTextureBlendMode(TextureRef texture, BlendMode blendMode)
Set the blend mode for a texture, used by RenderTexture().
Definition SDL3pp_render.h:5445
bool ViewportSet() const
Return whether an explicit rectangle was set as the viewport.
Definition SDL3pp_render.h:6342
Uint8 GetTextureAlphaMod(TextureConstRef texture)
Get the additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5271
void LockTexture(TextureRef texture, OptionalRef< const RectRaw > rect, void **pixels, int *pitch)
Lock a portion of the texture for write-only pixel access.
Definition SDL3pp_render.h:5742
void Unlock(TextureLock &&lock)
Unlock a texture, uploading the changes to video memory, if needed.
Definition SDL3pp_render.h:5840
void RenderTexture9GridTiled(RendererRef renderer, TextureRef texture, const FRectRaw &srcrect, float left_width, float right_width, float top_height, float bottom_height, float scale, const FRectRaw &dstrect, float tileScale)
Perform a scaled copy using the 9-grid algorithm to the current rendering target at subpixel precisio...
Definition SDL3pp_render.h:7369
void SetTextureAlphaMod(TextureRef texture, Uint8 alpha)
Set an additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5213
void SetTexturePalette(TextureRef texture, PaletteRef palette)
Set the palette used by a texture.
Definition SDL3pp_render.h:5023
Surface ReadPixels(OptionalRef< const RectRaw > rect={}) const
Read pixels from the current rendering target.
Definition SDL3pp_render.h:7631
Surface LockTextureToSurface(TextureRef texture, OptionalRef< const RectRaw > rect=std::nullopt)
Lock a portion of the texture for write-only pixel access, and expose it as a SDL surface.
Definition SDL3pp_render.h:5797
void ResetRenderTarget(RendererRef renderer)
Set target texture back to window.
Definition SDL3pp_render.h:5915
void SetTextureMod(TextureRef texture, Color c)
Set an additional color and alpha values multiplied into render copy operations.
Definition SDL3pp_render.h:5333
void SetRenderClipRect(RendererRef renderer, OptionalRef< const RectRaw > rect)
Set the clip rectangle for rendering on the specified target.
Definition SDL3pp_render.h:6396
void SetGPURenderStateFragmentUniforms(GPURenderStateRef state, Uint32 slot_index, const void *data, Uint32 length)
Set fragment shader uniform variables in a custom GPU render state.
Definition SDL3pp_render.h:8240
int GetTextureHeight(TextureConstRef texture)
Get the height in pixels.
Definition SDL3pp_render.h:4987
void RenderTextureRotated(TextureRef texture, OptionalRef< const FRectRaw > srcrect, OptionalRef< const FRectRaw > dstrect, double angle, OptionalRef< const FPointRaw > center, FlipMode flip=FlipMode::SDL_FLIP_NONE)
Copy a portion of the source texture to the current rendering target, with rotation and flipping,...
Definition SDL3pp_render.h:7157
::Sint64 Sint64
A signed 64-bit integer type.
Definition SDL3pp_stdinc.h:311
::Uint32 Uint32
An unsigned 32-bit integer type.
Definition SDL3pp_stdinc.h:296
::Uint8 Uint8
An unsigned 8-bit integer type.
Definition SDL3pp_stdinc.h:244
SDL_FlipMode FlipMode
The flip mode.
Definition SDL3pp_surface.h:130
SDL_ScaleMode ScaleMode
The scaling mode.
Definition SDL3pp_surface.h:101
SDL_Surface * SurfaceRaw
Alias to raw representation for Surface.
Definition SDL3pp_surface.h:47
ResourceRefT< SurfaceBase > SurfaceRef
Reference for Surface.
Definition SDL3pp_surface.h:57
ResourceConstRef< SurfaceRaw, SurfaceRawConst > SurfaceConstRef
Safely wrap Surface for non owning const parameters.
Definition SDL3pp_surface.h:60
ResourceRefT< RendererBase > RendererRef
Reference for Renderer.
Definition SDL3pp_video.h:86
Uint64 WindowFlags
The flags on a window.
Definition SDL3pp_video.h:526
SDL_Window * WindowRaw
Alias to raw representation for Window.
Definition SDL3pp_video.h:50
ResourceRefT< WindowBase > WindowRef
Reference for Window.
Definition SDL3pp_video.h:57
Properties for Renderer creation.
Definition SDL3pp_render.h:3815
constexpr auto SURFACE_POINTER
Pointer to surface.
Definition SDL3pp_render.h:3823
constexpr auto PRESENT_VSYNC_NUMBER
Number for present vsync.
Definition SDL3pp_render.h:3830
constexpr auto VULKAN_PHYSICAL_DEVICE_POINTER
Pointer to vulkan physical device.
Definition SDL3pp_render.h:3858
constexpr auto VULKAN_INSTANCE_POINTER
Pointer to vulkan instance.
Definition SDL3pp_render.h:3851
constexpr auto VULKAN_SURFACE_NUMBER
Vulkan surface number.
Definition SDL3pp_render.h:3855
constexpr auto GPU_SHADERS_SPIRV_BOOLEAN
Enable gpu shaders spirv.
Definition SDL3pp_render.h:3838
constexpr auto GPU_SHADERS_DXIL_BOOLEAN
Enable gpu shaders dxil.
Definition SDL3pp_render.h:3842
constexpr auto OUTPUT_COLORSPACE_NUMBER
Number for output colorspace.
Definition SDL3pp_render.h:3826
constexpr auto VULKAN_DEVICE_POINTER
Pointer to vulkan device.
Definition SDL3pp_render.h:3863
constexpr auto NAME_STRING
String for name.
Definition SDL3pp_render.h:3817
constexpr auto VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER
Vulkan graphics queue family index number.
Definition SDL3pp_render.h:3866
constexpr auto VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER
Vulkan present queue family index number.
Definition SDL3pp_render.h:3874
constexpr auto GPU_DEVICE_POINTER
Pointer to gpu device.
Definition SDL3pp_render.h:3835
constexpr auto GPU_SHADERS_MSL_BOOLEAN
Enable gpu shaders msl.
Definition SDL3pp_render.h:3846
constexpr auto WINDOW_POINTER
Pointer to window.
Definition SDL3pp_render.h:3820
Properties for Renderer.
Definition SDL3pp_render.h:3815
constexpr auto WINDOW_POINTER
Pointer to window.
Definition SDL3pp_render.h:4146
constexpr auto VULKAN_PHYSICAL_DEVICE_POINTER
Pointer to vulkan physical device.
Definition SDL3pp_render.h:4205
constexpr auto TEXTURE_FORMATS_POINTER
Pointer to texture formats.
Definition SDL3pp_render.h:4158
constexpr auto MAX_TEXTURE_SIZE_NUMBER
Number for max texture size.
Definition SDL3pp_render.h:4155
constexpr auto D3D12_DEVICE_POINTER
Pointer to d3d12 device.
Definition SDL3pp_render.h:4189
constexpr auto VULKAN_SURFACE_NUMBER
Vulkan surface number.
Definition SDL3pp_render.h:4202
constexpr auto D3D11_DEVICE_POINTER
Pointer to d3d11 device.
Definition SDL3pp_render.h:4183
constexpr auto VULKAN_DEVICE_POINTER
Pointer to vulkan device.
Definition SDL3pp_render.h:4209
constexpr auto GPU_DEVICE_POINTER
Pointer to gpu device.
Definition SDL3pp_render.h:4229
constexpr auto SURFACE_POINTER
Pointer to surface.
Definition SDL3pp_render.h:4149
constexpr auto D3D12_SWAPCHAIN_POINTER
Pointer to d3d12 swapchain.
Definition SDL3pp_render.h:4192
constexpr auto D3D12_COMMAND_QUEUE_POINTER
Pointer to d3d12 command queue.
Definition SDL3pp_render.h:4195
constexpr auto SDR_WHITE_POINT_FLOAT
Float for sdr white point.
Definition SDL3pp_render.h:4174
constexpr auto VULKAN_INSTANCE_POINTER
Pointer to vulkan instance.
Definition SDL3pp_render.h:4199
constexpr auto HDR_ENABLED_BOOLEAN
Hdr enabled enabled.
Definition SDL3pp_render.h:4171
constexpr auto TEXTURE_WRAPPING_BOOLEAN
Texture wrapping enabled.
Definition SDL3pp_render.h:4163
constexpr auto VSYNC_NUMBER
Number for vsync.
Definition SDL3pp_render.h:4152
constexpr auto VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER
Number for vulkan graphics queue family index.
Definition SDL3pp_render.h:4212
constexpr auto D3D11_SWAPCHAIN_POINTER
Pointer to d3d11 swapchain.
Definition SDL3pp_render.h:4186
constexpr auto VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER
Number for vulkan present queue family index.
Definition SDL3pp_render.h:4219
constexpr auto VULKAN_SWAPCHAIN_IMAGE_COUNT_NUMBER
Vulkan swapchain image count.
Definition SDL3pp_render.h:4225
constexpr auto HDR_HEADROOM_FLOAT
Float for hdr headroom.
Definition SDL3pp_render.h:4177
constexpr auto NAME_STRING
String for name.
Definition SDL3pp_render.h:4143
constexpr auto D3D9_DEVICE_POINTER
Pointer to d3d9 device.
Definition SDL3pp_render.h:4180
constexpr auto OUTPUT_COLORSPACE_NUMBER
Number for output colorspace.
Definition SDL3pp_render.h:4168
Properties for Texture creation.
Definition SDL3pp_render.h:4584
constexpr auto PALETTE_POINTER
Pointer to palette.
Definition SDL3pp_render.h:4603
constexpr auto METAL_PIXELBUFFER_POINTER
Pointer to metal pixelbuffer.
Definition SDL3pp_render.h:4636
constexpr auto FORMAT_NUMBER
Number for format.
Definition SDL3pp_render.h:4589
constexpr auto WIDTH_NUMBER
Number for width.
Definition SDL3pp_render.h:4595
constexpr auto HEIGHT_NUMBER
Number for height.
Definition SDL3pp_render.h:4598
constexpr auto D3D12_TEXTURE_U_POINTER
Pointer to d3d12 texture u.
Definition SDL3pp_render.h:4628
constexpr auto OPENGLES2_TEXTURE_V_NUMBER
Opengles2 texture v number.
Definition SDL3pp_render.h:4667
constexpr auto SDR_WHITE_POINT_FLOAT
Float for sdr white point.
Definition SDL3pp_render.h:4608
constexpr auto D3D11_TEXTURE_POINTER
Pointer to d3d11 texture.
Definition SDL3pp_render.h:4614
constexpr auto OPENGL_TEXTURE_V_NUMBER
Opengl texture v number.
Definition SDL3pp_render.h:4651
constexpr auto COLORSPACE_NUMBER
Number for colorspace.
Definition SDL3pp_render.h:4586
constexpr auto GPU_TEXTURE_V_POINTER
Pointer to gpu texture v.
Definition SDL3pp_render.h:4690
constexpr auto D3D12_TEXTURE_POINTER
Pointer to d3d12 texture.
Definition SDL3pp_render.h:4625
constexpr auto OPENGL_TEXTURE_NUMBER
Opengl texture number.
Definition SDL3pp_render.h:4640
constexpr auto GPU_TEXTURE_POINTER
Pointer to gpu texture.
Definition SDL3pp_render.h:4680
constexpr auto GPU_TEXTURE_U_POINTER
Pointer to gpu texture u.
Definition SDL3pp_render.h:4687
constexpr auto OPENGLES2_TEXTURE_UV_NUMBER
Opengles2 texture uv number.
Definition SDL3pp_render.h:4659
constexpr auto D3D11_TEXTURE_U_POINTER
Pointer to d3d11 texture u.
Definition SDL3pp_render.h:4617
constexpr auto OPENGL_TEXTURE_U_NUMBER
Opengl texture u number.
Definition SDL3pp_render.h:4647
constexpr auto GPU_TEXTURE_UV_POINTER
Pointer to gpu texture uv.
Definition SDL3pp_render.h:4683
constexpr auto OPENGLES2_TEXTURE_NUMBER
Opengles2 texture number.
Definition SDL3pp_render.h:4655
constexpr auto HDR_HEADROOM_FLOAT
Float for hdr headroom.
Definition SDL3pp_render.h:4611
constexpr auto D3D11_TEXTURE_V_POINTER
Pointer to d3d11 texture v.
Definition SDL3pp_render.h:4621
constexpr auto OPENGLES2_TEXTURE_U_NUMBER
Opengles2 texture u number.
Definition SDL3pp_render.h:4663
constexpr auto D3D12_TEXTURE_V_POINTER
Pointer to d3d12 texture v.
Definition SDL3pp_render.h:4632
constexpr auto ACCESS_NUMBER
Number for access.
Definition SDL3pp_render.h:4592
constexpr auto OPENGL_TEXTURE_UV_NUMBER
Opengl texture uv number.
Definition SDL3pp_render.h:4643
constexpr auto VULKAN_TEXTURE_NUMBER
Vulkans texture number.
Definition SDL3pp_render.h:4671
constexpr auto VULKAN_LAYOUT_NUMBER
Number for vulkan layout.
Definition SDL3pp_render.h:4677
Properties for Texture.
Definition SDL3pp_render.h:4584
constexpr auto OPENGL_TEX_W_FLOAT
Float for opengl tex w.
Definition SDL3pp_render.h:4869
constexpr auto D3D11_TEXTURE_U_POINTER
Pointer to d3d11 texture u.
Definition SDL3pp_render.h:4838
constexpr auto SDR_WHITE_POINT_FLOAT
Float for sdr white point.
Definition SDL3pp_render.h:4829
constexpr auto WIDTH_NUMBER
Number for width.
Definition SDL3pp_render.h:4823
constexpr auto VULKAN_TEXTURE_NUMBER
Vulkan texture number.
Definition SDL3pp_render.h:4894
constexpr auto D3D11_TEXTURE_V_POINTER
Pointer to d3d11 texture v.
Definition SDL3pp_render.h:4841
constexpr auto OPENGLES2_TEXTURE_NUMBER
Opengles2 texture number.
Definition SDL3pp_render.h:4875
constexpr auto D3D12_TEXTURE_U_POINTER
Pointer to d3d12 texture u.
Definition SDL3pp_render.h:4847
constexpr auto D3D12_TEXTURE_POINTER
Pointer to d3d12 texture.
Definition SDL3pp_render.h:4844
constexpr auto OPENGL_TEXTURE_TARGET_NUMBER
Opengl texture target number.
Definition SDL3pp_render.h:4865
constexpr auto OPENGLES2_TEXTURE_TARGET_NUMBER
Opengles2 texture target number.
Definition SDL3pp_render.h:4890
constexpr auto OPENGLES2_TEXTURE_V_NUMBER
Opengles2 texture v number.
Definition SDL3pp_render.h:4886
constexpr auto COLORSPACE_NUMBER
Number for colorspace.
Definition SDL3pp_render.h:4814
constexpr auto OPENGL_TEXTURE_NUMBER
Opengl texture number.
Definition SDL3pp_render.h:4853
constexpr auto OPENGL_TEXTURE_V_NUMBER
Opengl texture v number.
Definition SDL3pp_render.h:4862
constexpr auto GPU_TEXTURE_V_POINTER
Pointer to gpu texture v.
Definition SDL3pp_render.h:4908
constexpr auto OPENGL_TEXTURE_UV_NUMBER
Opengl texture uv number.
Definition SDL3pp_render.h:4856
constexpr auto FORMAT_NUMBER
Number for format.
Definition SDL3pp_render.h:4817
constexpr auto OPENGL_TEX_H_FLOAT
Float for opengl tex h.
Definition SDL3pp_render.h:4872
constexpr auto OPENGLES2_TEXTURE_UV_NUMBER
Opengles2 texture uv number.
Definition SDL3pp_render.h:4878
constexpr auto OPENGL_TEXTURE_U_NUMBER
Opengl texture u number.
Definition SDL3pp_render.h:4859
constexpr auto GPU_TEXTURE_U_POINTER
Pointer to gpu texture u.
Definition SDL3pp_render.h:4905
constexpr auto HDR_HEADROOM_FLOAT
Float for hdr headroom.
Definition SDL3pp_render.h:4832
constexpr auto ACCESS_NUMBER
Number for access.
Definition SDL3pp_render.h:4820
constexpr auto GPU_TEXTURE_UV_POINTER
Pointer to gpu texture uv.
Definition SDL3pp_render.h:4902
constexpr auto OPENGLES2_TEXTURE_U_NUMBER
Opengles2 texture u number.
Definition SDL3pp_render.h:4882
constexpr auto D3D12_TEXTURE_V_POINTER
Pointer to d3d12 texture v.
Definition SDL3pp_render.h:4850
constexpr auto HEIGHT_NUMBER
Number for height.
Definition SDL3pp_render.h:4826
constexpr auto GPU_TEXTURE_POINTER
Pointer to gpu texture.
Definition SDL3pp_render.h:4899
constexpr auto D3D11_TEXTURE_POINTER
Pointer to d3d11 texture.
Definition SDL3pp_render.h:4835
Main include header for the SDL3pp library.
Sint32 narrowS32(T value)
Narrows to Sint32.
Definition SDL3pp_stdinc.h:6262
A structure that represents a color as RGBA components.
Definition SDL3pp_pixels.h:2121
The bits of this structure can be directly reinterpreted as a float-packed color which uses the PIXEL...
Definition SDL3pp_pixels.h:2294
The structure that defines a point (using floating point values).
Definition SDL3pp_rect.h:422
A rectangle stored using floating point values.
Definition SDL3pp_rect.h:1351
Base class to GPURenderState.
Definition SDL3pp_render.h:8087
constexpr ResourceBaseT()=default
Default constructor, creates null/invalid resource.
A custom GPU render state.
Definition SDL3pp_render.h:8134
constexpr GPURenderState & operator=(GPURenderState &&other) noexcept
Assignment operator.
Definition SDL3pp_render.h:8179
~GPURenderState()
Destructor.
Definition SDL3pp_render.h:8176
constexpr GPURenderState(GPURenderState &&other) noexcept
Move constructor.
Definition SDL3pp_render.h:8150
constexpr GPURenderState(GPURenderStateRaw resource) noexcept
Constructs from raw GPURenderState.
Definition SDL3pp_render.h:8144
A set of indexed colors representing a palette.
Definition SDL3pp_pixels.h:2498
static Palette borrow(PaletteRaw resource)
Safely borrows the from PaletteRaw.
Definition SDL3pp_pixels.h:2551
The structure that defines a point (using integers).
Definition SDL3pp_rect.h:97
A rectangle, with the origin at the upper left (using integers).
Definition SDL3pp_rect.h:706
Base class to Renderer.
Definition SDL3pp_render.h:221
constexpr ResourceBaseT()=default
Default constructor, creates null/invalid resource.
A structure representing rendering state.
Definition SDL3pp_render.h:2090
constexpr Renderer(Renderer &&other) noexcept
Move constructor.
Definition SDL3pp_render.h:2106
constexpr Renderer(RendererRaw resource) noexcept
Constructs from raw Renderer.
Definition SDL3pp_render.h:2100
constexpr Renderer & operator=(Renderer &&other) noexcept
Assignment operator.
Definition SDL3pp_render.h:2232
~Renderer()
Destructor.
Definition SDL3pp_render.h:2229
A non-owning reference wrapper for a given resource.
Definition SDL3pp_resource.h:93
A collection of pixels used in software blitting.
Definition SDL3pp_surface.h:1677
static Surface borrow(SurfaceRaw resource)
Safely borrows the from SurfaceRaw.
Definition SDL3pp_surface.h:1844
constexpr Surface & operator=(Surface &&other) noexcept
Assignment operator.
Definition SDL3pp_surface.h:1857
constexpr Surface(SurfaceRaw resource) noexcept
Constructs from raw Surface.
Definition SDL3pp_surface.h:1687
Base class to Texture.
Definition SDL3pp_render.h:2245
constexpr ResourceBaseT()=default
Default constructor, creates null/invalid resource.
An efficient driver-specific representation of pixel data.
Definition SDL3pp_render.h:2999
constexpr Texture & operator=(Texture &&other) noexcept
Assignment operator.
Definition SDL3pp_render.h:3295
constexpr Texture(const Texture &other)
Copy constructor.
Definition SDL3pp_render.h:3015
Texture & operator=(const Texture &other)
Assignment operator.
Definition SDL3pp_render.h:3302
~Texture()
Destructor.
Definition SDL3pp_render.h:3292
static Texture borrow(TextureRaw resource)
Safely borrows the from TextureRaw.
Definition SDL3pp_render.h:3282
constexpr Texture(TextureRaw resource) noexcept
Constructs from raw Texture.
Definition SDL3pp_render.h:3009
constexpr Texture(Texture &&other) noexcept
Move constructor.
Definition SDL3pp_render.h:3021
The struct used as an opaque handle to a window.
Definition SDL3pp_video.h:2724