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;
1476 FlipMode flip = FlipMode::SDL_FLIP_NONE);
1572 float bottom_height,
1576#if SDL_VERSION_ATLEAST(3, 4, 0)
1617 float bottom_height,
1644 std::span<const Vertex> vertices,
1645 std::span<const int> indices = {});
1682 const void* indices,
1686#if SDL_VERSION_ATLEAST(3, 4, 0)
1898 Sint64 signal_semaphore);
2001 template<
class... ARGS>
2003 std::string_view fmt,
2006#if SDL_VERSION_ATLEAST(3, 4, 0)
2088 using RendererBase::RendererBase;
2385 void GetSize(
float* w,
float* h)
const;
2402#if SDL_VERSION_ATLEAST(3, 4, 0)
2844 const Uint8* Yplane,
2846 const Uint8* Uplane,
2848 const Uint8* Vplane,
2876 const Uint8* Yplane,
2878 const Uint8* UVplane,
2994 using TextureBase::TextureBase;
3279 ++resource->refcount;
3298 if (
get() != other.
get()) {
3366 : m_lock(std::move(other.m_lock))
3394 std::swap(m_lock, other.m_lock);
3399 constexpr operator bool()
const {
return bool(m_lock); }
3495 , m_lock(std::move(other.m_lock))
3523 std::swap(m_lock, other.m_lock);
3595 return SDL_GetRenderDriver(index);
3623 title, size.x, size.y, window_flags, window, renderer));
3649 SDL_Window* windowRaw =
nullptr;
3650 SDL_Renderer* rendererRaw =
nullptr;
3652 title, size, window_flags, &windowRaw, &rendererRaw);
3653 if (window) *window =
Window{windowRaw};
3654 if (renderer) *renderer =
Renderer{rendererRaw};
3723 :
Renderer(SDL_CreateRenderer(window, name))
3728 :
Renderer(SDL_CreateRendererWithProperties(props))
3733 :
Renderer(SDL_CreateSoftwareRenderer(surface))
3812 SDL_PROP_RENDERER_CREATE_NAME_STRING;
3815 SDL_PROP_RENDERER_CREATE_WINDOW_POINTER;
3818 SDL_PROP_RENDERER_CREATE_SURFACE_POINTER;
3821 SDL_PROP_RENDERER_CREATE_OUTPUT_COLORSPACE_NUMBER;
3825 SDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_NUMBER;
3827#if SDL_VERSION_ATLEAST(3, 4, 0)
3830 SDL_PROP_RENDERER_CREATE_GPU_DEVICE_POINTER;
3833 SDL_PROP_RENDERER_CREATE_GPU_SHADERS_SPIRV_BOOLEAN;
3837 SDL_PROP_RENDERER_CREATE_GPU_SHADERS_DXIL_BOOLEAN;
3841 SDL_PROP_RENDERER_CREATE_GPU_SHADERS_MSL_BOOLEAN;
3846 SDL_PROP_RENDERER_CREATE_VULKAN_INSTANCE_POINTER;
3850 SDL_PROP_RENDERER_CREATE_VULKAN_SURFACE_NUMBER;
3853 SDL_PROP_RENDERER_CREATE_VULKAN_PHYSICAL_DEVICE_POINTER;
3858 SDL_PROP_RENDERER_CREATE_VULKAN_DEVICE_POINTER;
3861 SDL_PROP_RENDERER_CREATE_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER;
3869 SDL_PROP_RENDERER_CREATE_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER;
3878#if SDL_VERSION_ATLEAST(3, 4, 0)
3914 return SDL_CreateGPURenderer(device, window);
3930 return SDL_GetGPURendererDevice(renderer);
3998 return CheckError(SDL_GetRenderWindow(renderer));
4022 return CheckError(SDL_GetRendererName(renderer));
4117 return CheckError(SDL_GetRendererProperties(renderer));
4138 SDL_PROP_RENDERER_NAME_STRING;
4141 SDL_PROP_RENDERER_WINDOW_POINTER;
4144 SDL_PROP_RENDERER_SURFACE_POINTER;
4147 SDL_PROP_RENDERER_VSYNC_NUMBER;
4150 SDL_PROP_RENDERER_MAX_TEXTURE_SIZE_NUMBER;
4153 SDL_PROP_RENDERER_TEXTURE_FORMATS_POINTER;
4155#if SDL_VERSION_ATLEAST(3, 4, 0)
4158 SDL_PROP_RENDERER_TEXTURE_WRAPPING_BOOLEAN;
4163 SDL_PROP_RENDERER_OUTPUT_COLORSPACE_NUMBER;
4166 SDL_PROP_RENDERER_HDR_ENABLED_BOOLEAN;
4169 SDL_PROP_RENDERER_SDR_WHITE_POINT_FLOAT;
4172 SDL_PROP_RENDERER_HDR_HEADROOM_FLOAT;
4175 SDL_PROP_RENDERER_D3D9_DEVICE_POINTER;
4178 SDL_PROP_RENDERER_D3D11_DEVICE_POINTER;
4181 SDL_PROP_RENDERER_D3D11_SWAPCHAIN_POINTER;
4184 SDL_PROP_RENDERER_D3D12_DEVICE_POINTER;
4187 SDL_PROP_RENDERER_D3D12_SWAPCHAIN_POINTER;
4190 SDL_PROP_RENDERER_D3D12_COMMAND_QUEUE_POINTER;
4194 SDL_PROP_RENDERER_VULKAN_INSTANCE_POINTER;
4197 SDL_PROP_RENDERER_VULKAN_SURFACE_NUMBER;
4200 SDL_PROP_RENDERER_VULKAN_PHYSICAL_DEVICE_POINTER;
4204 SDL_PROP_RENDERER_VULKAN_DEVICE_POINTER;
4207 SDL_PROP_RENDERER_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER;
4214 SDL_PROP_RENDERER_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER;
4220 SDL_PROP_RENDERER_VULKAN_SWAPCHAIN_IMAGE_COUNT_NUMBER;
4224 SDL_PROP_RENDERER_GPU_DEVICE_POINTER;
4250 CheckError(SDL_GetRenderOutputSize(renderer, w, h));
4311 CheckError(SDL_GetCurrentRenderOutputSize(renderer, w, h));
4377 return Texture(renderer, format, access, size);
4391 :
Texture(SDL_CreateTexture(renderer, format, access, size.x, size.y))
4396 :
Texture(SDL_CreateTextureFromSurface(renderer, surface))
4401 :
Texture(SDL_CreateTextureWithProperties(renderer, props))
4433 return Texture(renderer, surface);
4565 return Texture(renderer, props);
4581 SDL_PROP_TEXTURE_CREATE_COLORSPACE_NUMBER;
4584 SDL_PROP_TEXTURE_CREATE_FORMAT_NUMBER;
4587 SDL_PROP_TEXTURE_CREATE_ACCESS_NUMBER;
4590 SDL_PROP_TEXTURE_CREATE_WIDTH_NUMBER;
4593 SDL_PROP_TEXTURE_CREATE_HEIGHT_NUMBER;
4595#if SDL_VERSION_ATLEAST(3, 4, 0)
4598 SDL_PROP_TEXTURE_CREATE_PALETTE_POINTER;
4603 SDL_PROP_TEXTURE_CREATE_SDR_WHITE_POINT_FLOAT;
4606 SDL_PROP_TEXTURE_CREATE_HDR_HEADROOM_FLOAT;
4609 SDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_POINTER;
4612 SDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_U_POINTER;
4616 SDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_V_POINTER;
4620 SDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_POINTER;
4623 SDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_U_POINTER;
4627 SDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_V_POINTER;
4631 SDL_PROP_TEXTURE_CREATE_METAL_PIXELBUFFER_POINTER;
4635 SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_NUMBER;
4638 SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_UV_NUMBER;
4642 SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_U_NUMBER;
4646 SDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_V_NUMBER;
4650 SDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER;
4654 SDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_UV_NUMBER;
4658 SDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_U_NUMBER;
4662 SDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_V_NUMBER;
4666 SDL_PROP_TEXTURE_CREATE_VULKAN_TEXTURE_NUMBER;
4669#if SDL_VERSION_ATLEAST(3, 4, 0)
4672 SDL_PROP_TEXTURE_CREATE_VULKAN_LAYOUT_NUMBER;
4675 SDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_POINTER;
4678 SDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_UV_POINTER;
4682 SDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_U_POINTER;
4685 SDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_V_POINTER;
4788 return CheckError(SDL_GetTextureProperties(texture));
4809 SDL_PROP_TEXTURE_COLORSPACE_NUMBER;
4812 SDL_PROP_TEXTURE_FORMAT_NUMBER;
4815 SDL_PROP_TEXTURE_ACCESS_NUMBER;
4818 SDL_PROP_TEXTURE_WIDTH_NUMBER;
4821 SDL_PROP_TEXTURE_HEIGHT_NUMBER;
4824 SDL_PROP_TEXTURE_SDR_WHITE_POINT_FLOAT;
4827 SDL_PROP_TEXTURE_HDR_HEADROOM_FLOAT;
4830 SDL_PROP_TEXTURE_D3D11_TEXTURE_POINTER;
4833 SDL_PROP_TEXTURE_D3D11_TEXTURE_U_POINTER;
4836 SDL_PROP_TEXTURE_D3D11_TEXTURE_V_POINTER;
4839 SDL_PROP_TEXTURE_D3D12_TEXTURE_POINTER;
4842 SDL_PROP_TEXTURE_D3D12_TEXTURE_U_POINTER;
4845 SDL_PROP_TEXTURE_D3D12_TEXTURE_V_POINTER;
4848 SDL_PROP_TEXTURE_OPENGL_TEXTURE_NUMBER;
4851 SDL_PROP_TEXTURE_OPENGL_TEXTURE_UV_NUMBER;
4854 SDL_PROP_TEXTURE_OPENGL_TEXTURE_U_NUMBER;
4857 SDL_PROP_TEXTURE_OPENGL_TEXTURE_V_NUMBER;
4860 SDL_PROP_TEXTURE_OPENGL_TEXTURE_TARGET_NUMBER;
4864 SDL_PROP_TEXTURE_OPENGL_TEX_W_FLOAT;
4867 SDL_PROP_TEXTURE_OPENGL_TEX_H_FLOAT;
4870 SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_NUMBER;
4873 SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_UV_NUMBER;
4877 SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_U_NUMBER;
4881 SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_V_NUMBER;
4885 SDL_PROP_TEXTURE_OPENGLES2_TEXTURE_TARGET_NUMBER;
4889 SDL_PROP_TEXTURE_VULKAN_TEXTURE_NUMBER;
4891#if SDL_VERSION_ATLEAST(3, 4, 0)
4894 SDL_PROP_TEXTURE_GPU_TEXTURE_POINTER;
4897 SDL_PROP_TEXTURE_GPU_TEXTURE_UV_POINTER;
4900 SDL_PROP_TEXTURE_GPU_TEXTURE_U_POINTER;
4903 SDL_PROP_TEXTURE_GPU_TEXTURE_V_POINTER;
4922 return CheckError(SDL_GetRendererFromTexture(texture));
4946 CheckError(SDL_GetTextureSize(texture, w, h));
4952 return Point(texture->w, texture->h);
4988 return texture->format;
4996#if SDL_VERSION_ATLEAST(3, 4, 0)
5019 CheckError(SDL_SetTexturePalette(texture, palette));
5077 CheckError(SDL_SetTextureColorMod(texture, r, g, b));
5116 CheckError(SDL_SetTextureColorModFloat(texture, r, g, b));
5146 CheckError(SDL_GetTextureColorMod(texture, r, g, b));
5176 CheckError(SDL_GetTextureColorModFloat(texture, r, g, b));
5209 CheckError(SDL_SetTextureAlphaMod(texture, alpha));
5242 CheckError(SDL_SetTextureAlphaModFloat(texture, alpha));
5268 CheckError(SDL_GetTextureAlphaMod(texture, &alpha));
5295 CheckError(SDL_GetTextureAlphaModFloat(texture, &alpha));
5438 CheckError(SDL_SetTextureBlendMode(texture, blendMode));
5462 CheckError(SDL_GetTextureBlendMode(texture, &blendMode));
5490 CheckError(SDL_SetTextureScaleMode(texture, scaleMode));
5514 CheckError(SDL_GetTextureScaleMode(texture, &scaleMode));
5559 CheckError(SDL_UpdateTexture(texture, rect, pixels, pitch));
5596 UpdateTexture(texture, rect, surface->pixels, surface->pitch);
5639 const Uint8* Yplane,
5641 const Uint8* Uplane,
5643 const Uint8* Vplane,
5647 texture, rect, Yplane, Ypitch, Uplane, Upitch, Vplane, Vpitch));
5651 const Uint8* Yplane,
5653 const Uint8* Uplane,
5655 const Uint8* Vplane,
5659 get(), rect, Yplane, Ypitch, Uplane, Upitch, Vplane, Vpitch);
5688 const Uint8* Yplane,
5690 const Uint8* UVplane,
5694 SDL_UpdateNVTexture(texture, rect, Yplane, Ypitch, UVplane, UVpitch));
5698 const Uint8* Yplane,
5700 const Uint8* UVplane,
5738 CheckError(SDL_LockTexture(texture, rect, pixels, pitch));
5745 return {
TextureRef(*
this), rect, pixels, pitch};
5793 CheckError(SDL_LockTextureToSurface(texture, rect, &surface));
5834 std::move(lock).reset();
5840 std::move(lock).reset();
5845 if (!m_lock)
return;
5852 if (!m_lock)
return;
5883 CheckError(SDL_SetRenderTarget(renderer, texture));
5930 if (
auto texture = SDL_GetRenderTarget(renderer))
5987 CheckError(SDL_SetRenderLogicalPresentation(renderer, size.x, size.y, mode));
6023 CheckError(SDL_GetRenderLogicalPresentation(renderer, w, h, mode));
6095 CheckError(SDL_GetRenderLogicalPresentationRect(renderer, &rect));
6131 renderer, window_coord.x, window_coord.y, &p.x, &p.y));
6169 SDL_RenderCoordinatesToWindow(renderer, coord.x, coord.y, &p.x, &p.y));
6213 CheckError(SDL_ConvertEventToRenderCoordinates(renderer, event));
6248 CheckError(SDL_SetRenderViewport(renderer, rect));
6299 CheckError(SDL_GetRenderViewport(renderer, &rect));
6330 return SDL_RenderViewportSet(renderer);
6359 CheckError(SDL_GetRenderSafeArea(renderer, &rect));
6390 CheckError(SDL_SetRenderClipRect(renderer, rect));
6442 CheckError(SDL_GetRenderClipRect(renderer, &rect));
6470 return SDL_RenderClipEnabled(renderer);
6504 CheckError(SDL_SetRenderScale(renderer, scale.x, scale.y));
6531 CheckError(SDL_GetRenderScale(renderer, scaleX, scaleY));
6585 CheckError(SDL_SetRenderDrawColor(renderer, c.r, c.g, c.b, c.a));
6612 CheckError(SDL_SetRenderDrawColorFloat(renderer, c.r, c.g, c.b, c.a));
6647 CheckError(SDL_GetRenderDrawColor(renderer, r, g, b, a));
6711 CheckError(SDL_GetRenderDrawColorFloat(renderer, r, g, b, a));
6770 CheckError(SDL_SetRenderColorScale(renderer, scale));
6794 CheckError(SDL_GetRenderColorScale(renderer, &scale));
6820 CheckError(SDL_SetRenderDrawBlendMode(renderer, blendMode));
6844 CheckError(SDL_GetRenderDrawBlendMode(renderer, &blendMode));
6892 CheckError(SDL_RenderPoint(renderer, p.x, p.y));
6942 CheckError(SDL_RenderLine(renderer, p1.x, p1.y, p2.x, p2.y));
7041 CheckError(SDL_RenderFillRect(renderer, rect));
7098 CheckError(SDL_RenderTexture(renderer, texture, srcrect, dstrect));
7139 FlipMode flip = FlipMode::SDL_FLIP_NONE)
7142 renderer, texture, srcrect, dstrect, angle, center, flip));
7154 get(), texture, srcrect, dstrect, angle, center, flip);
7190 SDL_RenderTextureAffine(renderer, texture, srcrect, origin, right, down));
7234 SDL_RenderTextureTiled(renderer, texture, srcrect, scale, dstrect));
7284 float bottom_height,
7305 float bottom_height,
7320#if SDL_VERSION_ATLEAST(3, 4, 0)
7363 float bottom_height,
7368 CheckError(SDL_RenderTexture9GridTiled(renderer,
7385 float bottom_height,
7426 std::span<const Vertex> vertices,
7427 std::span<const int> indices = {})
7438 std::span<const Vertex> vertices,
7439 std::span<const int> indices)
7480 const void* indices,
7506 const void* indices,
7524#if SDL_VERSION_ATLEAST(3, 4, 0)
7548 CheckError(SDL_SetRenderTextureAddressMode(renderer, u_mode, v_mode));
7579 CheckError(SDL_GetRenderTextureAddressMode(renderer, u_mode, v_mode));
7616 return Surface{
CheckError(SDL_RenderReadPixels(renderer, rect))};
7710 SDL_DestroyRenderer(renderer);
7770 return SDL_GetRenderMetalLayer(renderer);
7801 return SDL_GetRenderMetalCommandEncoder(renderer);
7841 renderer, wait_stage_mask, wait_semaphore, signal_semaphore));
7849 get(), wait_stage_mask, wait_semaphore, signal_semaphore);
7876 CheckError(SDL_SetRenderVSync(renderer, vsync));
7907 CheckError(SDL_GetRenderVSync(renderer, &vsync));
7923 SDL_DEBUG_TEXT_FONT_CHARACTER_SIZE;
7966 CheckError(SDL_RenderDebugText(renderer, p.x, p.y, str));
7998template<
class... ARGS>
8001 std::string_view fmt,
8005 renderer, p, std::vformat(fmt, std::make_format_args(args...)));
8008template<
class... ARGS>
8010 std::string_view fmt,
8016#if SDL_VERSION_ATLEAST(3, 4, 0)
8036 CheckError(SDL_SetDefaultTextureScaleMode(renderer, scale_mode));
8061 CheckError(SDL_GetDefaultTextureScaleMode(renderer, scale_mode));
8123 using GPURenderStateBase::GPURenderStateBase;
8207 :
GPURenderState(SDL_CreateGPURenderState(renderer, &createinfo))
8234 SDL_SetGPURenderStateFragmentUniforms(state, slot_index, data, length));
8262 CheckError(SDL_SetGPURenderState(renderer, state));
8284 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:3323
TextureRef resource() const
Get the reference to locked resource.
Definition SDL3pp_render.h:3421
~TextureLock()
Unlock a texture, uploading the changes to video memory, if needed.
Definition SDL3pp_render.h:3387
TextureLock & operator=(TextureLock &&other) noexcept
Assignment operator.
Definition SDL3pp_render.h:3392
TextureLock(const TextureLock &other)=delete
Copy constructor.
TextureLock(TextureLock &&other) noexcept
Move constructor.
Definition SDL3pp_render.h:3365
void release()
Releases the lock without unlocking.
Definition SDL3pp_render.h:3424
Lock a portion of the texture for write-only pixel access, and expose it as a SDL surface.
Definition SDL3pp_render.h:3450
~TextureSurfaceLock()
Unlock a texture, uploading the changes to video memory, if needed.
Definition SDL3pp_render.h:3516
TextureSurfaceLock(TextureSurfaceLock &&other) noexcept
Move constructor.
Definition SDL3pp_render.h:3493
TextureRef resource() const
Get the reference to locked resource.
Definition SDL3pp_render.h:3548
TextureSurfaceLock(const TextureSurfaceLock &other)=delete
Copy constructor.
TextureSurfaceLock & operator=(TextureSurfaceLock &&other) noexcept
Assignment operator.
Definition SDL3pp_render.h:3521
#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:5179
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:6126
void reset()
Unlock a texture, uploading the changes to video memory, if needed.
Definition SDL3pp_render.h:5850
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:5554
RendererRef GetRenderer() const
Get the renderer associated with a window.
Definition SDL3pp_render.h:3980
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:5212
void SetDrawBlendMode(BlendMode blendMode)
Set the blend mode used for drawing operations (Fill and Line).
Definition SDL3pp_render.h:6823
void ResetTarget()
Set target texture back to window.
Definition SDL3pp_render.h:5911
void GetRenderScale(RendererRef renderer, float *scaleX, float *scaleY)
Get the drawing scale for the current target.
Definition SDL3pp_render.h:6529
constexpr int RENDERER_VSYNC_DISABLED
Constant for disabling renderer vsync.
Definition SDL3pp_render.h:7885
SDL_Vertex Vertex
Vertex structure.
Definition SDL3pp_render.h:117
FRect GetLogicalPresentationRect() const
Get the final presentation rectangle for rendering.
Definition SDL3pp_render.h:6099
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:7278
void GetRenderTextureAddressMode(TextureAddressMode *u_mode, TextureAddressMode *v_mode)
Get the texture addressing mode used in RenderGeometry().
Definition SDL3pp_render.h:7582
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:7013
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:7101
void ResetRenderViewport(RendererRef renderer)
Reset the drawing area for rendering to the entire target.
Definition SDL3pp_render.h:6272
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:7498
PropertiesRef GetProperties() const
Get the properties associated with a texture.
Definition SDL3pp_render.h:4791
Texture GetRenderTarget(RendererRef renderer)
Get the current render target.
Definition SDL3pp_render.h:5928
void SetColorModFloat(float r, float g, float b)
Set an additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5119
RendererRef CreateGPURenderer(GPUDeviceRef device, WindowRef window)
Create a 2D GPU rendering context.
Definition SDL3pp_render.h:3912
void Destroy()
Destroy custom GPU render state.
Definition SDL3pp_render.h:8287
Texture CreateTextureWithProperties(PropertiesRef props)
Create a texture for a rendering context with the specified properties.
Definition SDL3pp_render.h:4568
void FlushRenderer(RendererRef renderer)
Force the rendering context to flush any pending commands and state.
Definition SDL3pp_render.h:7745
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:7069
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:7044
GPURenderState CreateGPURenderState(RendererRef renderer, const GPURenderStateCreateInfo &createinfo)
Create custom GPU render state.
Definition SDL3pp_render.h:8191
void SetDefaultTextureScaleMode(RendererRef renderer, ScaleMode scale_mode)
Set default scale mode for new textures for given renderer.
Definition SDL3pp_render.h:8033
Rect GetSafeArea() const
Get the safe area for rendering within the current viewport.
Definition SDL3pp_render.h:6363
void CreateWindowAndRenderer(StringParam title, const PointRaw &size, WindowFlags window_flags, Window *window, Renderer *renderer)
Create a window and default renderer.
Definition SDL3pp_render.h:3643
ScaleMode GetTextureScaleMode(TextureConstRef texture)
Get the scale mode used for texture scale operations.
Definition SDL3pp_render.h:5511
void * GetRenderMetalLayer(RendererRef renderer)
Get the CAMetalLayer associated with the given Metal renderer.
Definition SDL3pp_render.h:7768
void SetClipRect(OptionalRef< const RectRaw > rect)
Set the clip rectangle for rendering on the specified target.
Definition SDL3pp_render.h:6393
void GetRenderOutputSize(RendererRef renderer, int *w, int *h)
Get the output size in pixels of a rendering context.
Definition SDL3pp_render.h:4248
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:5741
BlendMode GetTextureBlendMode(TextureConstRef texture)
Get the blend mode used for texture copy operations.
Definition SDL3pp_render.h:5459
void SetRenderTextureAddressMode(RendererRef renderer, TextureAddressMode u_mode, TextureAddressMode v_mode)
Set the texture addressing mode used in RenderGeometry().
Definition SDL3pp_render.h:7544
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:7299
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:8237
void CreateWindowAndRendererRaw(StringParam title, const PointRaw &size, WindowFlags window_flags, WindowRaw *window, RendererRaw *renderer)
Create a window and default renderer.
Definition SDL3pp_render.h:3616
void RenderDebugText(RendererRef renderer, const FPointRaw &p, StringParam str)
Draw debug text to an Renderer.
Definition SDL3pp_render.h:7962
void SetColorMod(Uint8 r, Uint8 g, Uint8 b)
Set an additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5080
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:7063
void RenderDebugTextFormat(const FPointRaw &p, std::string_view fmt, ARGS... args)
Draw debug text to an Renderer.
Definition SDL3pp_render.h:8009
FColor GetModFloat() const
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5415
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:5333
void SetVSync(int vsync)
Toggle VSync of the given renderer.
Definition SDL3pp_render.h:7879
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:6641
void SetGPURenderState(RendererRef renderer, GPURenderStateRef state)
Set custom GPU render state.
Definition SDL3pp_render.h:8260
void RenderPoint(RendererRef renderer, const FPointRaw &p)
Draw a point on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:6890
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:6989
Palette GetTexturePalette(TextureRef texture)
Get the palette used by a texture.
Definition SDL3pp_render.h:5040
void GetDefaultTextureScaleMode(ScaleMode *scale_mode)
Get default texture scale mode of the given renderer.
Definition SDL3pp_render.h:8064
void Flush()
Force the rendering context to flush any pending commands and state.
Definition SDL3pp_render.h:7750
Texture CreateTextureWithProperties(RendererRef renderer, PropertiesRef props)
Create a texture for a rendering context with the specified properties.
Definition SDL3pp_render.h:4562
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:6356
void SetViewport(OptionalRef< const RectRaw > rect)
Set the drawing area for rendering on the current target.
Definition SDL3pp_render.h:6251
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:5697
constexpr int RENDERER_VSYNC_ADAPTIVE
Constant for enabling asaptive renderer vsync.
Definition SDL3pp_render.h:7888
Point GetCurrentOutputSize() const
Get the current output size in pixels of a rendering context.
Definition SDL3pp_render.h:4345
int GetTextureWidth(TextureConstRef texture)
Get the width in pixels.
Definition SDL3pp_render.h:4976
PropertiesRef GetRendererProperties(RendererRef renderer)
Get the properties associated with a renderer.
Definition SDL3pp_render.h:4115
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:6768
void GetTextureColorMod(TextureConstRef texture, Uint8 *r, Uint8 *g, Uint8 *b)
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5141
void ConvertEventToRenderCoordinates(Event *event) const
Convert the coordinates in an event to render coordinates.
Definition SDL3pp_render.h:6216
void SetRenderVSync(RendererRef renderer, int vsync)
Toggle VSync of the given renderer.
Definition SDL3pp_render.h:7874
GPUDeviceRef GetGPURendererDevice(RendererRef renderer)
Return the GPU device used by a renderer.
Definition SDL3pp_render.h:3928
bool IsClipEnabled() const
Get whether clipping is enabled on the given render target.
Definition SDL3pp_render.h:6473
void GetRenderLogicalPresentation(RendererRef renderer, int *w, int *h, RendererLogicalPresentation *mode)
Get device independent resolution and presentation mode for rendering.
Definition SDL3pp_render.h:6018
Texture CreateTextureFromSurface(SurfaceRef surface)
Create a texture from an existing surface.
Definition SDL3pp_render.h:4436
void SetTextureModFloat(TextureRef texture, FColor c)
Set an additional color and alpha values multiplied into render copy operations.
Definition SDL3pp_render.h:5358
void RenderLine(const FPointRaw &p1, const FPointRaw &p2)
Draw a line on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:6945
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:5650
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:7380
void SetRenderTextureAddressMode(TextureAddressMode u_mode, TextureAddressMode v_mode)
Set the texture addressing mode used in RenderGeometry().
Definition SDL3pp_render.h:7551
void ResetClipRect()
Reset the clip rectangle for rendering to the entire render target.
Definition SDL3pp_render.h:6419
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:6507
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:7708
void GetTextureSize(TextureConstRef texture, float *w, float *h)
Get the size of a texture, as floating point values.
Definition SDL3pp_render.h:4944
void RenderClear()
Clear the current rendering target with the drawing color.
Definition SDL3pp_render.h:6875
Texture CreateTexture(RendererRef renderer, PixelFormat format, TextureAccess access, const PointRaw &size)
Create a texture for a rendering context.
Definition SDL3pp_render.h:4372
void Destroy()
Destroy the specified texture.
Definition SDL3pp_render.h:7693
Surface RenderReadPixels(RendererRef renderer, OptionalRef< const RectRaw > rect={})
Read pixels from the current rendering target.
Definition SDL3pp_render.h:7613
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:5803
Texture GetTarget() const
Get the current render target.
Definition SDL3pp_render.h:5935
void SetTextureScaleMode(TextureRef texture, ScaleMode scaleMode)
Set the scale mode used for texture scale operations.
Definition SDL3pp_render.h:5488
bool RenderClipEnabled(RendererRef renderer)
Get whether clipping is enabled on the given render target.
Definition SDL3pp_render.h:6468
Color GetDrawColor() const
Get the color used for drawing operations (Rect, Line and Clear).
Definition SDL3pp_render.h:6679
void SetRenderDrawColorFloat(RendererRef renderer, const FColorRaw &c)
Set the color used for drawing operations (Rect, Line and Clear).
Definition SDL3pp_render.h:6610
FColor GetDrawColorFloat() const
Get the color used for drawing operations (Rect, Line and Clear).
Definition SDL3pp_render.h:6743
float GetRenderColorScale(RendererRef renderer)
Get the color scale used for render operations.
Definition SDL3pp_render.h:6791
void RenderRects(SpanRef< const FRectRaw > rects)
Draw some number of rectangles on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:7018
Rect GetClipRect() const
Get the clip rectangle for the current target.
Definition SDL3pp_render.h:6446
Rect GetViewport() const
Get the drawing area for the current target.
Definition SDL3pp_render.h:6303
FRect GetRenderLogicalPresentationRect(RendererRef renderer)
Get the final presentation rectangle for rendering.
Definition SDL3pp_render.h:6092
FPoint GetTextureSizeFloat(TextureConstRef texture)
Get the size of a texture, as floating point values.
Definition SDL3pp_render.h:4963
RendererRef GetRendererFromTexture(TextureConstRef texture)
Get the renderer that created an Texture.
Definition SDL3pp_render.h:4920
void SetRenderDrawBlendMode(RendererRef renderer, BlendMode blendMode)
Set the blend mode used for drawing operations (Fill and Line).
Definition SDL3pp_render.h:6818
ResourceRefT< TextureBase > TextureRef
Reference for Texture.
Definition SDL3pp_render.h:63
Palette GetPalette()
Get the palette used by a texture.
Definition SDL3pp_render.h:5045
void RenderRect(OptionalRef< const FRectRaw > rect)
Draw a rectangle on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:6994
GPUDeviceRef GetGPUDevice()
Return the GPU device used by a renderer.
Definition SDL3pp_render.h:3933
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:7133
FPoint GetSizeFloat() const
Get the size of a texture, as floating point values.
Definition SDL3pp_render.h:4970
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:5797
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:7227
void RenderPoints(SpanRef< const FPointRaw > points)
Draw multiple points on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:6919
void SetTarget(TextureRef texture)
Set a texture as the current rendering target.
Definition SDL3pp_render.h:5886
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:6705
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:5022
void ResetRenderClipRect(RendererRef renderer)
Reset the clip rectangle for rendering to the entire render target.
Definition SDL3pp_render.h:6414
Texture CreateTexture(PixelFormat format, TextureAccess access, const PointRaw &size)
Create a texture for a rendering context.
Definition SDL3pp_render.h:4380
RendererRef GetRenderer(WindowRef window)
Get the renderer associated with a window.
Definition SDL3pp_render.h:3975
void * GetRenderMetalCommandEncoder(RendererRef renderer)
Get the Metal command encoder for the current frame.
Definition SDL3pp_render.h:7799
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:4001
void RenderDebugText(const FPointRaw &p, StringParam str)
Draw debug text to an Renderer.
Definition SDL3pp_render.h:7969
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:5686
FPoint RenderCoordinatesToWindow(const FPointRaw &coord) const
Get a point in window coordinates when given a point in render coordinates.
Definition SDL3pp_render.h:6173
void RenderDebugTextFormat(RendererRef renderer, const FPointRaw &p, std::string_view fmt, ARGS... args)
Draw debug text to an Renderer.
Definition SDL3pp_render.h:7999
int GetVSync() const
Get VSync of the given renderer.
Definition SDL3pp_render.h:7911
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:6913
void DestroyTexture(TextureRaw texture)
Destroy the specified texture.
Definition SDL3pp_render.h:7691
void GetLogicalPresentation(int *w, int *h, RendererLogicalPresentation *mode) const
Get device independent resolution and presentation mode for rendering.
Definition SDL3pp_render.h:6057
FColor GetTextureModFloat(TextureConstRef texture)
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5407
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:7038
void ResetViewport()
Reset the drawing area for rendering to the entire target.
Definition SDL3pp_render.h:6277
void RenderClear(RendererRef renderer)
Clear the current rendering target with the drawing color.
Definition SDL3pp_render.h:6870
int GetWidth() const
Get the width in pixels.
Definition SDL3pp_render.h:4978
Renderer CreateRenderer(WindowRef window, StringParam name=nullptr)
Create a 2D rendering context for a window.
Definition SDL3pp_render.h:3717
void DestroyGPURenderState(GPURenderStateRaw state)
Destroy custom GPU render state.
Definition SDL3pp_render.h:8282
void SetModFloat(FColor c)
Set an additional color and alpha values multiplied into render copy operations.
Definition SDL3pp_render.h:5364
PixelFormat GetTextureFormat(TextureConstRef texture)
Get the pixel format.
Definition SDL3pp_render.h:4986
float GetAlphaModFloat() const
Get the additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5299
void RenderPoint(const FPointRaw &p)
Draw a point on the current rendering target at subpixel precision.
Definition SDL3pp_render.h:6895
Uint8 GetAlphaMod() const
Get the additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5272
ResourceRefT< GPURenderStateBase > GPURenderStateRef
Reference for GPURenderState.
Definition SDL3pp_render.h:84
void SetGPURenderState(GPURenderStateRef state)
Set custom GPU render state.
Definition SDL3pp_render.h:8265
void Present()
Update the screen with any rendering performed since the previous call.
Definition SDL3pp_render.h:7674
BlendMode GetDrawBlendMode() const
Get the blend mode used for drawing operations.
Definition SDL3pp_render.h:6848
void SetDrawColor(ColorRaw c)
Set the color used for drawing operations.
Definition SDL3pp_render.h:6588
Renderer CreateRendererWithProperties(PropertiesRef props)
Create a 2D rendering context for a window, with the specified properties.
Definition SDL3pp_render.h:3799
void GetColorMod(Uint8 *r, Uint8 *g, Uint8 *b) const
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5149
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:5637
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:5518
Rect GetRenderViewport(RendererRef renderer)
Get the drawing area for the current target.
Definition SDL3pp_render.h:6296
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:5466
void * GetRenderMetalCommandEncoder()
Get the Metal command encoder for the current frame.
Definition SDL3pp_render.h:7804
void SetDrawColorFloat(const FColorRaw &c)
Set the color used for drawing operations (Rect, Line and Clear).
Definition SDL3pp_render.h:6615
Point GetSize() const
Get the size of a texture.
Definition SDL3pp_render.h:4960
Rect GetRenderClipRect(RendererRef renderer)
Get the clip rectangle for the current target.
Definition SDL3pp_render.h:6439
void SetAlphaModFloat(float alpha)
Set an additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5245
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:6938
void SetRenderLogicalPresentation(RendererRef renderer, const PointRaw &size, RendererLogicalPresentation mode)
Set a device-independent resolution and presentation mode for rendering.
Definition SDL3pp_render.h:5983
Color GetMod() const
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5391
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:7437
void reset()
Unlock a texture, uploading the changes to video memory, if needed.
Definition SDL3pp_render.h:5843
void SetTextureColorMod(TextureRef texture, Uint8 r, Uint8 g, Uint8 b)
Set an additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5075
void GetDefaultTextureScaleMode(RendererRef renderer, ScaleMode *scale_mode)
Get default texture scale mode of the given renderer.
Definition SDL3pp_render.h:8058
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:6798
void SetRenderTarget(RendererRef renderer, TextureRef texture)
Set a texture as the current rendering target.
Definition SDL3pp_render.h:5881
int GetRenderVSync(RendererRef renderer)
Get VSync of the given renderer.
Definition SDL3pp_render.h:7904
constexpr int DEBUG_TEXT_FONT_CHARACTER_SIZE
The size, in pixels, of a single RenderDebugText() character.
Definition SDL3pp_render.h:7922
BlendMode GetRenderDrawBlendMode(RendererRef renderer)
Get the blend mode used for drawing operations.
Definition SDL3pp_render.h:6841
PixelFormat GetFormat() const
Get the pixel format.
Definition SDL3pp_render.h:4991
int GetHeight() const
Get the height in pixels.
Definition SDL3pp_render.h:4983
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:7713
PropertiesRef GetTextureProperties(TextureConstRef texture)
Get the properties associated with a texture.
Definition SDL3pp_render.h:4786
void SetBlendMode(BlendMode blendMode)
Set the blend mode for a texture, used by RenderTexture().
Definition SDL3pp_render.h:5441
void SetRenderDrawColor(RendererRef renderer, ColorRaw c)
Set the color used for drawing operations.
Definition SDL3pp_render.h:6583
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:5748
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:7237
FPoint RenderCoordinatesToWindow(RendererRef renderer, const FPointRaw &coord)
Get a point in window coordinates when given a point in render coordinates.
Definition SDL3pp_render.h:6164
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:7424
Point GetOutputSize() const
Get the output size in pixels of a rendering context.
Definition SDL3pp_render.h:4284
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:5111
Texture CreateTextureFromSurface(RendererRef renderer, SurfaceRef surface)
Create a texture from an existing surface.
Definition SDL3pp_render.h:4430
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:6970
void SetTextureAlphaModFloat(TextureRef texture, float alpha)
Set an additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5240
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:7093
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:7844
void GetRenderTextureAddressMode(RendererRef renderer, TextureAddressMode *u_mode, TextureAddressMode *v_mode)
Get the texture addressing mode used in RenderGeometry().
Definition SDL3pp_render.h:7575
Renderer CreateSoftwareRenderer(SurfaceRef surface)
Create a 2D software rendering context for a surface.
Definition SDL3pp_render.h:3959
const char * GetName() const
Get the name of a renderer.
Definition SDL3pp_render.h:4025
void ConvertEventToRenderCoordinates(RendererRef renderer, Event *event)
Convert the coordinates in an event to render coordinates.
Definition SDL3pp_render.h:6211
Color GetTextureMod(TextureConstRef texture)
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5383
FPoint RenderCoordinatesFromWindow(const FPointRaw &window_coord) const
Get a point in render coordinates when given a point in window coordinates.
Definition SDL3pp_render.h:6135
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:7471
void SetLogicalPresentation(const PointRaw &size, RendererLogicalPresentation mode)
Set a device-independent resolution and presentation mode for rendering.
Definition SDL3pp_render.h:5990
GPURenderState CreateGPURenderState(const GPURenderStateCreateInfo &createinfo)
Create custom GPU render state.
Definition SDL3pp_render.h:8198
void SetRenderScale(RendererRef renderer, const FPointRaw &scale)
Set the drawing scale for rendering on the current target.
Definition SDL3pp_render.h:6502
void SetRenderViewport(RendererRef renderer, OptionalRef< const RectRaw > rect)
Set the drawing area for rendering on the current target.
Definition SDL3pp_render.h:6245
void RenderPresent(RendererRef renderer)
Update the screen with any rendering performed since the previous call.
Definition SDL3pp_render.h:7669
void SetDefaultTextureScaleMode(ScaleMode scale_mode)
Set default scale mode for new textures for given renderer.
Definition SDL3pp_render.h:8039
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:7182
void UnlockTexture(TextureRef texture)
Unlock a texture, uploading the changes to video memory, if needed.
Definition SDL3pp_render.h:5829
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:7835
void SetScaleMode(ScaleMode scaleMode)
Set the scale mode used for texture scale operations.
Definition SDL3pp_render.h:5493
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:4020
FPoint GetScale() const
Get the drawing scale for the current target.
Definition SDL3pp_render.h:6561
void GetCurrentRenderOutputSize(RendererRef renderer, int *w, int *h)
Get the current output size in pixels of a rendering context.
Definition SDL3pp_render.h:4309
float GetTextureAlphaModFloat(TextureConstRef texture)
Get the additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5292
void SetColorScale(float scale)
Set the color scale used for render operations.
Definition SDL3pp_render.h:6773
int GetNumRenderDrivers()
Get the number of 2D rendering drivers available for the current display.
Definition SDL3pp_render.h:3569
const char * GetRenderDriver(int index)
Use this function to get the name of a built in 2D rendering driver.
Definition SDL3pp_render.h:3593
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:6964
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:7193
WindowRef GetRenderWindow(RendererRef renderer)
Get the window associated with a renderer.
Definition SDL3pp_render.h:3996
void * GetRenderMetalLayer()
Get the CAMetalLayer associated with the given Metal renderer.
Definition SDL3pp_render.h:7773
RendererRef GetRenderer() const
Get the renderer that created an Texture.
Definition SDL3pp_render.h:4925
void Update(OptionalRef< const RectRaw > rect, const void *pixels, int pitch)
Update the given texture rectangle with new pixel data.
Definition SDL3pp_render.h:5599
bool RenderViewportSet(RendererRef renderer)
Return whether an explicit rectangle was set as the viewport.
Definition SDL3pp_render.h:6328
void GetTextureColorModFloat(TextureConstRef texture, float *r, float *g, float *b)
Get the additional color value multiplied into render copy operations.
Definition SDL3pp_render.h:5171
PropertiesRef GetProperties() const
Get the properties associated with a renderer.
Definition SDL3pp_render.h:4120
void SetTextureBlendMode(TextureRef texture, BlendMode blendMode)
Set the blend mode for a texture, used by RenderTexture().
Definition SDL3pp_render.h:5436
bool ViewportSet() const
Return whether an explicit rectangle was set as the viewport.
Definition SDL3pp_render.h:6333
Uint8 GetTextureAlphaMod(TextureConstRef texture)
Get the additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5265
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:5733
void Unlock(TextureLock &&lock)
Unlock a texture, uploading the changes to video memory, if needed.
Definition SDL3pp_render.h:5831
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:7357
void SetTextureAlphaMod(TextureRef texture, Uint8 alpha)
Set an additional alpha value multiplied into render copy operations.
Definition SDL3pp_render.h:5207
void SetTexturePalette(TextureRef texture, PaletteRef palette)
Set the palette used by a texture.
Definition SDL3pp_render.h:5017
Surface ReadPixels(OptionalRef< const RectRaw > rect={}) const
Read pixels from the current rendering target.
Definition SDL3pp_render.h:7619
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:5788
void ResetRenderTarget(RendererRef renderer)
Set target texture back to window.
Definition SDL3pp_render.h:5906
void SetTextureMod(TextureRef texture, Color c)
Set an additional color and alpha values multiplied into render copy operations.
Definition SDL3pp_render.h:5327
void SetRenderClipRect(RendererRef renderer, OptionalRef< const RectRaw > rect)
Set the clip rectangle for rendering on the specified target.
Definition SDL3pp_render.h:6387
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:8228
int GetTextureHeight(TextureConstRef texture)
Get the height in pixels.
Definition SDL3pp_render.h:4981
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:7145
::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:3809
constexpr auto SURFACE_POINTER
Pointer to surface.
Definition SDL3pp_render.h:3817
constexpr auto PRESENT_VSYNC_NUMBER
Number for present vsync.
Definition SDL3pp_render.h:3824
constexpr auto VULKAN_PHYSICAL_DEVICE_POINTER
Pointer to vulkan physical device.
Definition SDL3pp_render.h:3852
constexpr auto VULKAN_INSTANCE_POINTER
Pointer to vulkan instance.
Definition SDL3pp_render.h:3845
constexpr auto VULKAN_SURFACE_NUMBER
Vulkan surface number.
Definition SDL3pp_render.h:3849
constexpr auto GPU_SHADERS_SPIRV_BOOLEAN
Enable gpu shaders spirv.
Definition SDL3pp_render.h:3832
constexpr auto GPU_SHADERS_DXIL_BOOLEAN
Enable gpu shaders dxil.
Definition SDL3pp_render.h:3836
constexpr auto OUTPUT_COLORSPACE_NUMBER
Number for output colorspace.
Definition SDL3pp_render.h:3820
constexpr auto VULKAN_DEVICE_POINTER
Pointer to vulkan device.
Definition SDL3pp_render.h:3857
constexpr auto NAME_STRING
String for name.
Definition SDL3pp_render.h:3811
constexpr auto VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER
Vulkan graphics queue family index number.
Definition SDL3pp_render.h:3860
constexpr auto VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER
Vulkan present queue family index number.
Definition SDL3pp_render.h:3868
constexpr auto GPU_DEVICE_POINTER
Pointer to gpu device.
Definition SDL3pp_render.h:3829
constexpr auto GPU_SHADERS_MSL_BOOLEAN
Enable gpu shaders msl.
Definition SDL3pp_render.h:3840
constexpr auto WINDOW_POINTER
Pointer to window.
Definition SDL3pp_render.h:3814
Properties for Renderer.
Definition SDL3pp_render.h:3809
constexpr auto WINDOW_POINTER
Pointer to window.
Definition SDL3pp_render.h:4140
constexpr auto VULKAN_PHYSICAL_DEVICE_POINTER
Pointer to vulkan physical device.
Definition SDL3pp_render.h:4199
constexpr auto TEXTURE_FORMATS_POINTER
Pointer to texture formats.
Definition SDL3pp_render.h:4152
constexpr auto MAX_TEXTURE_SIZE_NUMBER
Number for max texture size.
Definition SDL3pp_render.h:4149
constexpr auto D3D12_DEVICE_POINTER
Pointer to d3d12 device.
Definition SDL3pp_render.h:4183
constexpr auto VULKAN_SURFACE_NUMBER
Vulkan surface number.
Definition SDL3pp_render.h:4196
constexpr auto D3D11_DEVICE_POINTER
Pointer to d3d11 device.
Definition SDL3pp_render.h:4177
constexpr auto VULKAN_DEVICE_POINTER
Pointer to vulkan device.
Definition SDL3pp_render.h:4203
constexpr auto GPU_DEVICE_POINTER
Pointer to gpu device.
Definition SDL3pp_render.h:4223
constexpr auto SURFACE_POINTER
Pointer to surface.
Definition SDL3pp_render.h:4143
constexpr auto D3D12_SWAPCHAIN_POINTER
Pointer to d3d12 swapchain.
Definition SDL3pp_render.h:4186
constexpr auto D3D12_COMMAND_QUEUE_POINTER
Pointer to d3d12 command queue.
Definition SDL3pp_render.h:4189
constexpr auto SDR_WHITE_POINT_FLOAT
Float for sdr white point.
Definition SDL3pp_render.h:4168
constexpr auto VULKAN_INSTANCE_POINTER
Pointer to vulkan instance.
Definition SDL3pp_render.h:4193
constexpr auto HDR_ENABLED_BOOLEAN
Hdr enabled enabled.
Definition SDL3pp_render.h:4165
constexpr auto TEXTURE_WRAPPING_BOOLEAN
Texture wrapping enabled.
Definition SDL3pp_render.h:4157
constexpr auto VSYNC_NUMBER
Number for vsync.
Definition SDL3pp_render.h:4146
constexpr auto VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER
Number for vulkan graphics queue family index.
Definition SDL3pp_render.h:4206
constexpr auto D3D11_SWAPCHAIN_POINTER
Pointer to d3d11 swapchain.
Definition SDL3pp_render.h:4180
constexpr auto VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER
Number for vulkan present queue family index.
Definition SDL3pp_render.h:4213
constexpr auto VULKAN_SWAPCHAIN_IMAGE_COUNT_NUMBER
Vulkan swapchain image count.
Definition SDL3pp_render.h:4219
constexpr auto HDR_HEADROOM_FLOAT
Float for hdr headroom.
Definition SDL3pp_render.h:4171
constexpr auto NAME_STRING
String for name.
Definition SDL3pp_render.h:4137
constexpr auto D3D9_DEVICE_POINTER
Pointer to d3d9 device.
Definition SDL3pp_render.h:4174
constexpr auto OUTPUT_COLORSPACE_NUMBER
Number for output colorspace.
Definition SDL3pp_render.h:4162
Properties for Texture creation.
Definition SDL3pp_render.h:4578
constexpr auto PALETTE_POINTER
Pointer to palette.
Definition SDL3pp_render.h:4597
constexpr auto METAL_PIXELBUFFER_POINTER
Pointer to metal pixelbuffer.
Definition SDL3pp_render.h:4630
constexpr auto FORMAT_NUMBER
Number for format.
Definition SDL3pp_render.h:4583
constexpr auto WIDTH_NUMBER
Number for width.
Definition SDL3pp_render.h:4589
constexpr auto HEIGHT_NUMBER
Number for height.
Definition SDL3pp_render.h:4592
constexpr auto D3D12_TEXTURE_U_POINTER
Pointer to d3d12 texture u.
Definition SDL3pp_render.h:4622
constexpr auto OPENGLES2_TEXTURE_V_NUMBER
Opengles2 texture v number.
Definition SDL3pp_render.h:4661
constexpr auto SDR_WHITE_POINT_FLOAT
Float for sdr white point.
Definition SDL3pp_render.h:4602
constexpr auto D3D11_TEXTURE_POINTER
Pointer to d3d11 texture.
Definition SDL3pp_render.h:4608
constexpr auto OPENGL_TEXTURE_V_NUMBER
Opengl texture v number.
Definition SDL3pp_render.h:4645
constexpr auto COLORSPACE_NUMBER
Number for colorspace.
Definition SDL3pp_render.h:4580
constexpr auto GPU_TEXTURE_V_POINTER
Pointer to gpu texture v.
Definition SDL3pp_render.h:4684
constexpr auto D3D12_TEXTURE_POINTER
Pointer to d3d12 texture.
Definition SDL3pp_render.h:4619
constexpr auto OPENGL_TEXTURE_NUMBER
Opengl texture number.
Definition SDL3pp_render.h:4634
constexpr auto GPU_TEXTURE_POINTER
Pointer to gpu texture.
Definition SDL3pp_render.h:4674
constexpr auto GPU_TEXTURE_U_POINTER
Pointer to gpu texture u.
Definition SDL3pp_render.h:4681
constexpr auto OPENGLES2_TEXTURE_UV_NUMBER
Opengles2 texture uv number.
Definition SDL3pp_render.h:4653
constexpr auto D3D11_TEXTURE_U_POINTER
Pointer to d3d11 texture u.
Definition SDL3pp_render.h:4611
constexpr auto OPENGL_TEXTURE_U_NUMBER
Opengl texture u number.
Definition SDL3pp_render.h:4641
constexpr auto GPU_TEXTURE_UV_POINTER
Pointer to gpu texture uv.
Definition SDL3pp_render.h:4677
constexpr auto OPENGLES2_TEXTURE_NUMBER
Opengles2 texture number.
Definition SDL3pp_render.h:4649
constexpr auto HDR_HEADROOM_FLOAT
Float for hdr headroom.
Definition SDL3pp_render.h:4605
constexpr auto D3D11_TEXTURE_V_POINTER
Pointer to d3d11 texture v.
Definition SDL3pp_render.h:4615
constexpr auto OPENGLES2_TEXTURE_U_NUMBER
Opengles2 texture u number.
Definition SDL3pp_render.h:4657
constexpr auto D3D12_TEXTURE_V_POINTER
Pointer to d3d12 texture v.
Definition SDL3pp_render.h:4626
constexpr auto ACCESS_NUMBER
Number for access.
Definition SDL3pp_render.h:4586
constexpr auto OPENGL_TEXTURE_UV_NUMBER
Opengl texture uv number.
Definition SDL3pp_render.h:4637
constexpr auto VULKAN_TEXTURE_NUMBER
Vulkans texture number.
Definition SDL3pp_render.h:4665
constexpr auto VULKAN_LAYOUT_NUMBER
Number for vulkan layout.
Definition SDL3pp_render.h:4671
Properties for Texture.
Definition SDL3pp_render.h:4578
constexpr auto OPENGL_TEX_W_FLOAT
Float for opengl tex w.
Definition SDL3pp_render.h:4863
constexpr auto D3D11_TEXTURE_U_POINTER
Pointer to d3d11 texture u.
Definition SDL3pp_render.h:4832
constexpr auto SDR_WHITE_POINT_FLOAT
Float for sdr white point.
Definition SDL3pp_render.h:4823
constexpr auto WIDTH_NUMBER
Number for width.
Definition SDL3pp_render.h:4817
constexpr auto VULKAN_TEXTURE_NUMBER
Vulkan texture number.
Definition SDL3pp_render.h:4888
constexpr auto D3D11_TEXTURE_V_POINTER
Pointer to d3d11 texture v.
Definition SDL3pp_render.h:4835
constexpr auto OPENGLES2_TEXTURE_NUMBER
Opengles2 texture number.
Definition SDL3pp_render.h:4869
constexpr auto D3D12_TEXTURE_U_POINTER
Pointer to d3d12 texture u.
Definition SDL3pp_render.h:4841
constexpr auto D3D12_TEXTURE_POINTER
Pointer to d3d12 texture.
Definition SDL3pp_render.h:4838
constexpr auto OPENGL_TEXTURE_TARGET_NUMBER
Opengl texture target number.
Definition SDL3pp_render.h:4859
constexpr auto OPENGLES2_TEXTURE_TARGET_NUMBER
Opengles2 texture target number.
Definition SDL3pp_render.h:4884
constexpr auto OPENGLES2_TEXTURE_V_NUMBER
Opengles2 texture v number.
Definition SDL3pp_render.h:4880
constexpr auto COLORSPACE_NUMBER
Number for colorspace.
Definition SDL3pp_render.h:4808
constexpr auto OPENGL_TEXTURE_NUMBER
Opengl texture number.
Definition SDL3pp_render.h:4847
constexpr auto OPENGL_TEXTURE_V_NUMBER
Opengl texture v number.
Definition SDL3pp_render.h:4856
constexpr auto GPU_TEXTURE_V_POINTER
Pointer to gpu texture v.
Definition SDL3pp_render.h:4902
constexpr auto OPENGL_TEXTURE_UV_NUMBER
Opengl texture uv number.
Definition SDL3pp_render.h:4850
constexpr auto FORMAT_NUMBER
Number for format.
Definition SDL3pp_render.h:4811
constexpr auto OPENGL_TEX_H_FLOAT
Float for opengl tex h.
Definition SDL3pp_render.h:4866
constexpr auto OPENGLES2_TEXTURE_UV_NUMBER
Opengles2 texture uv number.
Definition SDL3pp_render.h:4872
constexpr auto OPENGL_TEXTURE_U_NUMBER
Opengl texture u number.
Definition SDL3pp_render.h:4853
constexpr auto GPU_TEXTURE_U_POINTER
Pointer to gpu texture u.
Definition SDL3pp_render.h:4899
constexpr auto HDR_HEADROOM_FLOAT
Float for hdr headroom.
Definition SDL3pp_render.h:4826
constexpr auto ACCESS_NUMBER
Number for access.
Definition SDL3pp_render.h:4814
constexpr auto GPU_TEXTURE_UV_POINTER
Pointer to gpu texture uv.
Definition SDL3pp_render.h:4896
constexpr auto OPENGLES2_TEXTURE_U_NUMBER
Opengles2 texture u number.
Definition SDL3pp_render.h:4876
constexpr auto D3D12_TEXTURE_V_POINTER
Pointer to d3d12 texture v.
Definition SDL3pp_render.h:4844
constexpr auto HEIGHT_NUMBER
Number for height.
Definition SDL3pp_render.h:4820
constexpr auto GPU_TEXTURE_POINTER
Pointer to gpu texture.
Definition SDL3pp_render.h:4893
constexpr auto D3D11_TEXTURE_POINTER
Pointer to d3d11 texture.
Definition SDL3pp_render.h:4829
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:8075
constexpr ResourceBaseT()=default
Default constructor, creates null/invalid resource.
A custom GPU render state.
Definition SDL3pp_render.h:8122
constexpr GPURenderState & operator=(GPURenderState &&other) noexcept
Assignment operator.
Definition SDL3pp_render.h:8167
~GPURenderState()
Destructor.
Definition SDL3pp_render.h:8164
constexpr GPURenderState(GPURenderState &&other) noexcept
Move constructor.
Definition SDL3pp_render.h:8138
constexpr GPURenderState(GPURenderStateRaw resource) noexcept
Constructs from raw GPURenderState.
Definition SDL3pp_render.h:8132
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:2087
constexpr Renderer(Renderer &&other) noexcept
Move constructor.
Definition SDL3pp_render.h:2103
constexpr Renderer(RendererRaw resource) noexcept
Constructs from raw Renderer.
Definition SDL3pp_render.h:2097
constexpr Renderer & operator=(Renderer &&other) noexcept
Assignment operator.
Definition SDL3pp_render.h:2229
~Renderer()
Destructor.
Definition SDL3pp_render.h:2226
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:2242
constexpr ResourceBaseT()=default
Default constructor, creates null/invalid resource.
An efficient driver-specific representation of pixel data.
Definition SDL3pp_render.h:2993
constexpr Texture & operator=(Texture &&other) noexcept
Assignment operator.
Definition SDL3pp_render.h:3289
constexpr Texture(const Texture &other)
Copy constructor.
Definition SDL3pp_render.h:3009
Texture & operator=(const Texture &other)
Assignment operator.
Definition SDL3pp_render.h:3296
~Texture()
Destructor.
Definition SDL3pp_render.h:3286
static Texture borrow(TextureRaw resource)
Safely borrows the from TextureRaw.
Definition SDL3pp_render.h:3276
constexpr Texture(TextureRaw resource) noexcept
Constructs from raw Texture.
Definition SDL3pp_render.h:3003
constexpr Texture(Texture &&other) noexcept
Move constructor.
Definition SDL3pp_render.h:3015
The struct used as an opaque handle to a window.
Definition SDL3pp_video.h:2724