Initial Video, Render, and Properties implementations.
Co-authored-by: Copilot <copilot@github.com>
This commit is contained in:
BadQuanta
@@ -0,0 +1,156 @@
|
||||
#pragma once
|
||||
/**
|
||||
* @file Display.hpp
|
||||
* @brief HDK sdl video header only wrapper for the SDL_DisplayID type and related functions
|
||||
*/
|
||||
#include <SDL3/SDL_video.h>
|
||||
#include <hdk/grid/PrimitiveWrapper.hpp>
|
||||
#include <hdk/sdl/Properties.hpp>
|
||||
#include <vector>
|
||||
/** Displays represent physical display devices such as monitors. */
|
||||
namespace hdk::sdl {
|
||||
/**
|
||||
* @brief A wrapper for SDL_DisplayID that provides type safety and convenience functions for working with display IDs
|
||||
* in SDL.
|
||||
*
|
||||
*/
|
||||
class Display : public grid::PrimitiveWrapper<SDL_DisplayID> {
|
||||
public:
|
||||
using grid::PrimitiveWrapper<SDL_DisplayID>::PrimitiveWrapper;
|
||||
/** @see SDL_GetClosestFullscreenDisplayMode
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetClosestFullscreenDisplayMode
|
||||
* @brief Get the closest match to the requested display mode for fullscreen mode.
|
||||
* @param w requested width in pixels
|
||||
* @param h requested height in pixels
|
||||
* @param refresh_rate 0.0f for desktop refresh rate,
|
||||
* @param include_high_density_modes whether to include high density display modes in the search
|
||||
* @param closest A pointer to a display mode to be filled in with the closest match of the available display
|
||||
* modes. May be NULL to just get the number of matching video modes.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetClosestFullscreenMode(
|
||||
int w, int h, float refresh_rate, bool include_high_density_modes, SDL_DisplayMode* closest) {
|
||||
return SDL_GetClosestFullscreenDisplayMode(*this, w, h, refresh_rate, include_high_density_modes, closest);
|
||||
}
|
||||
/** @see SDL_GetCurrentDisplayMode
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetCurrentDisplayMode
|
||||
* @brief Get the current display mode of a display.
|
||||
* @return display mode of the display.
|
||||
*/
|
||||
const SDL_DisplayMode* GetCurrentMode() const { return SDL_GetCurrentDisplayMode(*this); }
|
||||
/** @see SDL_GetCurrentDisplayOrientation
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetCurrentDisplayOrientation
|
||||
* @return orientation of the display
|
||||
*/
|
||||
SDL_DisplayOrientation GetCurrentOrientation() const { return SDL_GetCurrentDisplayOrientation(*this); }
|
||||
/** @see SDL_GetDesktopDisplayMode
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetDesktopDisplayMode
|
||||
* @return desktop display mode of the display
|
||||
*/
|
||||
const SDL_DisplayMode* GetDesktopMode() const { return SDL_GetDesktopDisplayMode(*this); }
|
||||
/** @see SDL_GetDisplayBounds
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetDisplayBounds
|
||||
* @brief Get the bounds of a display.
|
||||
* @param rect A pointer to an SDL_Rect structure to be filled in with the display
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetBounds(SDL_Rect* rect) const { return SDL_GetDisplayBounds(*this, rect); }
|
||||
/** @see SDL_GetDisplayContentScale
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetDisplayContentScale
|
||||
* @return The content scale factor for the display
|
||||
*/
|
||||
float GetContentScale() const { return SDL_GetDisplayContentScale(*this); }
|
||||
/** @see SDL_GetDisplayForPoint
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetDisplayForPoint
|
||||
* @brief Get the display that contains a point.
|
||||
* @param point A pointer to an SDL_Point structure representing the point to query
|
||||
*/
|
||||
static Display GetForPoint(const SDL_Point* point) { return Display(SDL_GetDisplayForPoint(point)); }
|
||||
/** @see SDL_GetDisplayForRect
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetDisplayForRect
|
||||
* @brief Get the display that most closely intersects a rectangle.
|
||||
* @param rect A pointer to an SDL_Rect structure representing the rectangle to query
|
||||
*/
|
||||
static Display GetForRect(const SDL_Rect* rect) { return Display(SDL_GetDisplayForRect(rect)); }
|
||||
/** @see SDL_GetDisplayForWindow
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetDisplayForWindow
|
||||
* @brief Get the display associated with a window.
|
||||
* @param window The window to query
|
||||
* @return Display The display associated with the window
|
||||
*/
|
||||
static Display GetForWindow(SDL_Window* window) { return Display(SDL_GetDisplayForWindow(window)); }
|
||||
/** @see SDL_GetDisplayName
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetDisplayName
|
||||
* @return The name of the display.
|
||||
*/
|
||||
const char* GetName() const { return SDL_GetDisplayName(*this); }
|
||||
/** @see SDL_GetDisplayProperties
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetDisplayProperties
|
||||
* @return Properties associated with the display.
|
||||
*/
|
||||
Properties GetProperties() const { return Properties(SDL_GetDisplayProperties(*this)); }
|
||||
/** @see SDL_GetDisplays
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetDisplays
|
||||
* @param count pointer to int filled with the count of displays
|
||||
* @returns an array of DisplayIDs representing the displays
|
||||
* @note Must be freed with SDL_free() when finished.
|
||||
*/
|
||||
static SDL_DisplayID* GetDisplays(int* count) { return SDL_GetDisplays(count); }
|
||||
/** @see SDL_GetDisplays
|
||||
* @returns std::vector Display(s) available
|
||||
*/
|
||||
static std::vector<Display> GetDisplays() {
|
||||
int count;
|
||||
SDL_DisplayID* displayIDs = SDL_GetDisplays(&count);
|
||||
std::vector<Display> displays;
|
||||
if (displayIDs) {
|
||||
displays.reserve(count);
|
||||
for (int i = 0; i < count; ++i) {
|
||||
displays.emplace_back(displayIDs[i]);
|
||||
}
|
||||
SDL_free(displayIDs);
|
||||
}
|
||||
return displays;
|
||||
}
|
||||
/** @see SDL_GetDisplayUsableBounds
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetDisplayUsableBounds
|
||||
* @brief Get the usable bounds of a display.
|
||||
* @param rect A pointer to an SDL_Rect structure to be filled in with the usable bounds
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetUsableBounds(SDL_Rect* rect) const { return SDL_GetDisplayUsableBounds(*this, rect); }
|
||||
/** @see SDL_GetFullscreenDisplayModes
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetFullscreenDisplayModes
|
||||
* @param count pointer to int filled with the count of display modes
|
||||
* @return null terminated array of display modes available for fullscreen mode
|
||||
* @note Must be freed with SDL_free() when finished.
|
||||
*/
|
||||
SDL_DisplayMode** GetFullscreenModes(int* count) const { return SDL_GetFullscreenDisplayModes(*this, count); }
|
||||
/** @see SDL_GetFullscreenDisplayModes
|
||||
* @returns std::vector of display modes available for fullscreen mode
|
||||
*/
|
||||
std::vector<SDL_DisplayMode> GetFullscreenModes() const {
|
||||
int count;
|
||||
SDL_DisplayMode** modes = SDL_GetFullscreenDisplayModes(*this, &count);
|
||||
std::vector<SDL_DisplayMode> displayModes;
|
||||
if (modes) {
|
||||
displayModes.reserve(count);
|
||||
for (int i = 0; i < count; ++i) {
|
||||
displayModes.push_back(*modes[i]);
|
||||
}
|
||||
SDL_free(modes);
|
||||
}
|
||||
return displayModes;
|
||||
}
|
||||
/** @see SDL_GetNaturalDisplayOrientation
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetNaturalDisplayOrientation
|
||||
* @return The natural orientation of the display
|
||||
*/
|
||||
SDL_DisplayOrientation GetNaturalOrientation() const { return SDL_GetNaturalDisplayOrientation(*this); }
|
||||
/** @see SDL_GetPrimaryDisplay
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetPrimaryDisplay
|
||||
* @return The primary display
|
||||
*/
|
||||
static Display GetPrimaryDisplay() { return Display(SDL_GetPrimaryDisplay()); }
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,529 @@
|
||||
#pragma once
|
||||
/** @file Surface.hpp
|
||||
* @brief Defines the Surface class for handling SDL surfaces.
|
||||
*/
|
||||
#include <SDL3/SDL.h>
|
||||
#include <hdk/grid/SharedPtrWrapper.hpp>
|
||||
/** Surfaces hold bitmap data **/
|
||||
namespace hdk::sdl {
|
||||
class Surface : public hdk::grid::SharedPtrWrapper<SDL_Surface> {
|
||||
public:
|
||||
/** Inherit constructors from SharedPtrWrapper */
|
||||
using hdk::grid::SharedPtrWrapper<SDL_Surface>::SharedPtrWrapper;
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_AddSurfaceAlternateImage
|
||||
* @brief Add an alternate image to a surface.
|
||||
* @param surface The surface to add the alternate image to.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool AddAlternateImage(SDL_Surface* surface) const { return SDL_AddSurfaceAlternateImage(*this, surface); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_BlitSurface
|
||||
* @brief Perform a fast blit from `this` surface to the destination surface.
|
||||
* @param dst_surface The destination surface to blit on to.
|
||||
* @param dst_rect A pointer to an SDL_Rect structure representing the area on the destination surface to blit
|
||||
* onto, or NULL to blit onto the entire surface.
|
||||
* @param src_rect A pointer to an SDL_Rect structure representing the area of the source surface to blit, or
|
||||
* NULL to blit the entire surface.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool BlitTo(
|
||||
SDL_Surface* dst_surface, const SDL_Rect* dst_rect = nullptr, const SDL_Rect* src_rect = nullptr) const {
|
||||
return SDL_BlitSurface(*this, src_rect, dst_surface, dst_rect);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_BlitSurface
|
||||
* @brief Perform a fast blit to `this` surface from a source surface.
|
||||
* @param src_surface The source surface to blit from.
|
||||
* @param src_rect A pointer to an SDL_Rect structure representing the area on the source surface to blit
|
||||
* from, or NULL to blit the entire surface.
|
||||
* @param dst_rect A pointer to an SDL_Rect structure representing the area of the destination surface to blit,
|
||||
* or NULL to blit the entire surface.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool BlitFrom(
|
||||
SDL_Surface* src_surface, const SDL_Rect* src_rect = nullptr, const SDL_Rect* dst_rect = nullptr) const {
|
||||
return SDL_BlitSurface(src_surface, src_rect, *this, dst_rect);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_BlitSurface9Grid
|
||||
* @brief Perform a blit with 9-grid scaling from `this` surface to the destination surface.
|
||||
* @param dst_surface The destination surface to blit on to.
|
||||
* @param dst_rect A pointer to an SDL_Rect structure representing the area on the destination
|
||||
* @param left_width The width of the left columns of the 9-grid
|
||||
* @param right_width The width of the right columns of the 9-grid
|
||||
* @param top_height The height of the top rows of the 9-grid
|
||||
* @param bottom_height The height of the bottom rows of the 9-grid
|
||||
* @param scale The scale factor to apply to the center of the 9-grid
|
||||
* @param scale_mode
|
||||
* @param src_rect
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool Blit9GridTo(SDL_Surface* dst_surface, const SDL_Rect* dst_rect, int left_width, int right_width,
|
||||
int top_height, int bottom_height, float scale, SDL_ScaleMode scale_mode,
|
||||
const SDL_Rect* src_rect = nullptr) const {
|
||||
return SDL_BlitSurface9Grid(*this, src_rect, left_width, right_width, top_height, bottom_height, scale,
|
||||
scale_mode, dst_surface, dst_rect);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_BlitSurface9Grid
|
||||
* @brief Perform a blit with 9-grid scaling to `this` surface from a source surface.
|
||||
* @param src_surface The source surface to blit from.
|
||||
* @param src_rect
|
||||
* @param left_width The width of the left columns of the 9-grid
|
||||
* @param right_width The width of the right columns of the 9-grid
|
||||
* @param top_height The height of the top rows of the 9-grid
|
||||
* @param bottom_height The height of the bottom rows of the 9-grid
|
||||
* @param scale The scale factor to apply to the center of the 9-grid
|
||||
* @param scale_mode
|
||||
* @param dst_rect A pointer to an SDL_Rect structure representing the area on the destination surface to blit, or
|
||||
NULL to blit the entire surface.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool Blit9GridFrom(SDL_Surface* src_surface, const SDL_Rect* src_rect, int left_width, int right_width,
|
||||
int top_height, int bottom_height, float scale, SDL_ScaleMode scale_mode,
|
||||
const SDL_Rect* dst_rect = nullptr) const {
|
||||
return SDL_BlitSurface9Grid(src_surface, src_rect, left_width, right_width, top_height, bottom_height, scale,
|
||||
scale_mode, *this, dst_rect);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_BlitSurfaceScaled
|
||||
* @brief Perform a scaled blit from `this` surface to the destination surface.
|
||||
* @param dst_surface The destination surface to blit on to.
|
||||
* @param dst_rect A pointer to an SDL_Rect structure representing the area on the destination
|
||||
* @param scale_mode The scale mode to use for scaling the surface
|
||||
* @param src_rect A pointer to an SDL_Rect structure representing the area of the source
|
||||
* surface to blit, or NULL to blit the entire surface.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool BlitScaledTo(SDL_Surface* dst_surface, const SDL_Rect* dst_rect, SDL_ScaleMode scale_mode,
|
||||
const SDL_Rect* src_rect = nullptr) const {
|
||||
return SDL_BlitSurfaceScaled(*this, src_rect, dst_surface, dst_rect, scale_mode);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_BlitSurfaceScaled
|
||||
* @brief Perform a scaled blit to `this` surface from a source surface.
|
||||
* @param src_surface The source surface to blit from.
|
||||
* @param src_rect A pointer to an SDL_Rect structure representing the area on the source
|
||||
* @param scale_mode The scale mode to use for scaling the surface
|
||||
* @param dst_rect A pointer to an SDL_Rect structure representing the area on the destination surface to blit, or
|
||||
* NULL to blit the entire surface.
|
||||
* @return bool true
|
||||
*/
|
||||
bool BlitScaledFrom(SDL_Surface* src_surface, const SDL_Rect* src_rect, SDL_ScaleMode scale_mode,
|
||||
const SDL_Rect* dst_rect = nullptr) const {
|
||||
return SDL_BlitSurfaceScaled(src_surface, src_rect, *this, dst_rect, scale_mode);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_BlitSurfaceTiled
|
||||
* @brief Perform a tiled blit from `this` surface to the destination surface.
|
||||
* @param dst_surface The destination surface to blit on to.
|
||||
* @param dst_rect A pointer to an SDL_Rect structure representing the area on the destination surface to blit
|
||||
* onto, or NULL to blit onto the entire surface.
|
||||
* @param src_rect A pointer to an SDL_Rect structure representing the area of the source surface to blit, or NULL
|
||||
* to blit the entire surface.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool BlitTiledTo(
|
||||
SDL_Surface* dst_surface, const SDL_Rect* dst_rect = nullptr, const SDL_Rect* src_rect = nullptr) const {
|
||||
return SDL_BlitSurfaceTiled(*this, src_rect, dst_surface, dst_rect);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_BlitSurfaceTiled
|
||||
* @brief Perform a tiled blit to `this` surface from a source surface.
|
||||
* @param src_surface The source surface to blit from.
|
||||
* @param src_rect A pointer to an SDL_Rect structure representing the area on the source surface to blit, or NULL
|
||||
* to blit the entire surface.
|
||||
* @param dst_rect A pointer to an SDL_Rect structure representing the area of the destination surface to blit, or
|
||||
* NULL to blit the entire surface.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool BlitTiledFrom(
|
||||
SDL_Surface* src_surface, const SDL_Rect* src_rect = nullptr, const SDL_Rect* dst_rect = nullptr) const {
|
||||
return SDL_BlitSurfaceTiled(src_surface, src_rect, *this, dst_rect);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_BlitSurfaceTiledWithScale
|
||||
* @brief Perform a tiled blit with scale from `this` surface to the destination surface.
|
||||
* @param dst_surface The destination surface to blit on to.
|
||||
* @param dst_rect A pointer to an SDL_Rect structure representing the area on the destination surface to blit
|
||||
* onto, or NULL to blit onto the entire surface.
|
||||
* @param scale The scale factor to apply to the source surface when blitting.
|
||||
* @param scale_mode The scale mode to use for scaling the surface
|
||||
* @param src_rect A pointer to an SDL_Rect structure representing the area of the source
|
||||
*/
|
||||
bool BlitTiledWithScaleTo(SDL_Surface* dst_surface, const SDL_Rect* dst_rect, float scale,
|
||||
SDL_ScaleMode scale_mode, const SDL_Rect* src_rect = nullptr) const {
|
||||
return SDL_BlitSurfaceTiledWithScale(*this, src_rect, scale, scale_mode, dst_surface, dst_rect);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_BlitSurfaceTiledWithScale
|
||||
* @brief Perform a tiled blit with scale to `this` surface from a source surface.
|
||||
* @param src_surface The source surface to blit from.
|
||||
* @param src_rect A pointer to an SDL_Rect structure representing the area of the source surface to blit, or NULL
|
||||
* to blit the entire surface.
|
||||
* @param scale The scale factor to apply to the source surface when blitting.
|
||||
* @param scale_mode The scale mode to use for scaling the surface
|
||||
* @param dst_rect A pointer to an SDL_Rect structure representing the area of the destination surface to blit, or
|
||||
* NULL to blit the entire surface.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool BlitTiledWithScaleFrom(SDL_Surface* src_surface, const SDL_Rect* src_rect, float scale,
|
||||
SDL_ScaleMode scale_mode, const SDL_Rect* dst_rect = nullptr) const {
|
||||
return SDL_BlitSurfaceTiledWithScale(src_surface, src_rect, scale, scale_mode, *this, dst_rect);
|
||||
}
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_BlitSurfaceUnchecked
|
||||
*/
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_BlitSurfaceUncheckedScaled
|
||||
*/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_ClearSurface
|
||||
* @brief Clear the surface to the specified color.
|
||||
* @param r
|
||||
* @param g
|
||||
* @param b
|
||||
* @param a
|
||||
*/
|
||||
void Clear(float r, float g, float b, float a) const { SDL_ClearSurface(*this, r, g, b, a); }
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_ConvertPixels
|
||||
*/
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_ConvertPixelsAndColorspace
|
||||
*/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_ConvertSurface
|
||||
* @brief Convert surface to specified pixel format.
|
||||
* @param format The pixel format to convert to.
|
||||
* @return A new Surface instance with the converted surface, or nullptr on failure.
|
||||
*/
|
||||
Surface Convert(SDL_PixelFormat format) const {
|
||||
return get_or_cache(SDL_ConvertSurface(*this, format), SDL_DestroySurface);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_ConvertSurfaceAndColorspace
|
||||
* @brief Convert surface to specified pixel format and colorspace.
|
||||
* @param format
|
||||
* @param palette (optional) The palette to use for the converted surface, or NULL to use the palette from the
|
||||
* original surface.
|
||||
* @param colorspace
|
||||
* @param properties (optional) can be 0.
|
||||
* @return A new Surface instance with the converted surface, or nullptr on failure.
|
||||
*/
|
||||
Surface ConvertAndColorspace(SDL_PixelFormat format, SDL_Palette* palette, SDL_Colorspace colorspace,
|
||||
SDL_PropertiesID properties = 0) const {
|
||||
return get_or_cache(
|
||||
SDL_ConvertSurfaceAndColorspace(*this, format, palette, colorspace, properties), SDL_DestroySurface);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_CreateSurface
|
||||
* @brief Create a new surface
|
||||
* @param w
|
||||
* @param h
|
||||
* @param format
|
||||
* @return A new Surface instance with the created surface, or nullptr on failure.
|
||||
*/
|
||||
static Surface Create(int w, int h, SDL_PixelFormat format) {
|
||||
return get_or_cache(SDL_CreateSurface(w, h, format), SDL_DestroySurface);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_CreateSurfaceFrom
|
||||
* @brief Create a new surface from existing pixel data.
|
||||
* @param w
|
||||
* @param h
|
||||
* @param format
|
||||
* @param pixels
|
||||
* @param pitch
|
||||
* @return A new Surface instance with the created surface, or nullptr on failure.
|
||||
*/
|
||||
static Surface CreateFrom(int w, int h, SDL_PixelFormat format, void* pixels, int pitch) {
|
||||
return get_or_cache(SDL_CreateSurfaceFrom(w, h, format, pixels, pitch), SDL_DestroySurface);
|
||||
}
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_CreateSurfacePalette */
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_DestroySurface
|
||||
*/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_DuplicateSurface
|
||||
* @brief Create a new surface that is a duplicate of the original surface.
|
||||
* @return A new Surface instance with the duplicated surface, or nullptr on failure.
|
||||
*/
|
||||
Surface Duplicate() const { return get_or_cache(SDL_DuplicateSurface(*this), SDL_DestroySurface); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_FillSurfaceRect
|
||||
* @brief Fill a rectangle on the surface with a color.
|
||||
* @param rect A pointer to an SDL_Rect structure representing the rectangle to fill, or NULL to fill the entire
|
||||
* surface.
|
||||
* @param color
|
||||
*/
|
||||
void FillRect(const SDL_Rect* rect, Uint32 color) const { SDL_FillSurfaceRect(*this, rect, color); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_FillSurfaceRects
|
||||
* @brief Fill multiple rectangles on the surface with a color.
|
||||
* @param rects An array of SDL_Rect structures representing the rectangles to fill.
|
||||
* @param count The number of rectangles in the rects array.
|
||||
* @param color
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool FillRects(const SDL_Rect* rects, int count, Uint32 color) const {
|
||||
return SDL_FillSurfaceRects(*this, rects, count, color);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_FlipSurface
|
||||
* @brief Flip the surface.
|
||||
* @param flip_mode SDL_FlipMode enum to control horizontal, vertical, or both flipping.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool Flip(SDL_FlipMode flip_mode) const { return SDL_FlipSurface(*this, flip_mode); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetSurfaceAlphaMod
|
||||
* @brief Get the surface's alpha modulation value.
|
||||
* @param alpha pointer to 8bit to receive the alpha modulation value (0-255).
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetAlphaMod(Uint8* alpha) const { return SDL_GetSurfaceAlphaMod(*this, alpha); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetSurfaceBlendMode
|
||||
* @brief Get the surface's blend mode.
|
||||
* @param blend_mode pointer to an SDL_BlendMode variable to receive the blend mode
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetBlendMode(SDL_BlendMode* blend_mode) const { return SDL_GetSurfaceBlendMode(*this, blend_mode); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetSurfaceClipRect
|
||||
* @brief Get the surface's clipping rectangle.
|
||||
* @param rect pointer to an SDL_Rect structure to receive the clipping rectangle
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetClipRect(SDL_Rect* rect) const { return SDL_GetSurfaceClipRect(*this, rect); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetSurfaceColorKey
|
||||
* @brief Get the surface's color key.
|
||||
* @param color_key pointer to a Uint32 variable to receive the color key value
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetColorKey(Uint32* color_key) const { return SDL_GetSurfaceColorKey(*this, color_key); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetSurfaceColorMod
|
||||
* @brief Get the surface's color modulation values.
|
||||
* @param r pointer to Uint8 variable to receive the red color modulation value
|
||||
* @param g pointer to Uint8 variable to receive the green color modulation value
|
||||
* @param b pointer to Uint8 variable to receive the blue color modulation value
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetColorMod(Uint8* r, Uint8* g, Uint8* b) const { return SDL_GetSurfaceColorMod(*this, r, g, b); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetSurfaceColorspace
|
||||
* @brief Get the surface's colorspace.
|
||||
* @return The colorspace of the surface.
|
||||
*/
|
||||
SDL_Colorspace GetColorspace() const { return SDL_GetSurfaceColorspace(*this); }
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_GetSurfaceImages
|
||||
*/
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_GetSurfacePalette
|
||||
*/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetSurfaceProperties
|
||||
* @brief Get the surface's properties.
|
||||
* @return The properties set associated with the surface.
|
||||
*/
|
||||
SDL_PropertiesID GetProperties() const { return SDL_GetSurfaceProperties(*this); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_LoadBMP
|
||||
* @brief Load a BMP image from a file and return a new surface containing the image.
|
||||
* @param file The file path of the BMP image to load.
|
||||
* @return A new Surface instance with the loaded surface, or nullptr on failure.
|
||||
*/
|
||||
static Surface LoadBMP(const char* file) { return get_or_cache(SDL_LoadBMP(file), SDL_DestroySurface); }
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_LoadBMP_IO
|
||||
*/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_LoadPNG
|
||||
* @brief Load a PNG image from a file and return a new surface containing the image.
|
||||
* @param file The file path of the PNG image to load.
|
||||
* @return A new Surface instance with the loaded surface, or nullptr on failure.
|
||||
*/
|
||||
static Surface LoadPNG(const char* file) { return get_or_cache(SDL_LoadPNG(file), SDL_DestroySurface); }
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_LoadPNG_IO
|
||||
*/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_LoadSurface
|
||||
* @brief Load a surface from a file. PNG or BMP image formats are supported.
|
||||
* @param file The file path of the image to load.
|
||||
* @return A new Surface instance with the loaded surface, or nullptr on failure.
|
||||
*/
|
||||
static Surface LoadSurface(const char* file) { return get_or_cache(SDL_LoadSurface(file), SDL_DestroySurface); }
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_LoadSurface_IO
|
||||
*/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_LockSurface
|
||||
* @brief Lock the surface for direct pixel access.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool Lock() const { return SDL_LockSurface(*this); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_MapSurfaceRGB
|
||||
* @brief Map RGB values to a pixel format and return the mapped color value.
|
||||
* @param r The red component of the color
|
||||
* @param g The green component of the color
|
||||
* @param b The blue component of the color
|
||||
* @return The mapped color value in the surface's pixel format.
|
||||
*/
|
||||
Uint32 MapRGB(Uint8 r, Uint8 g, Uint8 b) const { return SDL_MapSurfaceRGB(*this, r, g, b); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_MapSurfaceRGBA
|
||||
* @brief Map RGBA values to a pixel format and return the mapped color value.
|
||||
* @param r The red component of the color
|
||||
* @param g The green component of the color
|
||||
* @param b The blue component of the color
|
||||
* @param a The alpha component of the color
|
||||
* @return The mapped color value in the surface's pixel format.
|
||||
*/
|
||||
Uint32 MapRGBA(Uint8 r, Uint8 g, Uint8 b, Uint8 a) const { return SDL_MapSurfaceRGBA(*this, r, g, b, a); }
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_PremultiplyAlpha
|
||||
*/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_PremultiplySurfaceAlpha
|
||||
* @brief Premultiply the surface's alpha values into its color values.
|
||||
* @param linear
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool PremultiplyAlpha(bool linear) const { return SDL_PremultiplySurfaceAlpha(*this, linear); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_ReadSurfacePixel
|
||||
* @brief Read a pixel from the surface at the specified coordinates and return its color value.
|
||||
* @param x
|
||||
* @param y
|
||||
* @param r pointer to Uint8 variable to receive the red component of the pixel's color
|
||||
* @param g pointer to Uint8 variable to receive the green component of the pixel's color
|
||||
* @param b pointer to Uint8 variable to receive the blue component of the pixel's color
|
||||
* @param a pointer to Uint8 variable to receive the alpha component of the pixel's color
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool ReadPixel(int x, int y, Uint8* r, Uint8* g, Uint8* b, Uint8* a) const {
|
||||
return SDL_ReadSurfacePixel(*this, x, y, r, g, b, a);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_ReadSurfacePixelFloat
|
||||
* @brief Read a pixel from the surface at the specified coordinates and return its color value as floats.
|
||||
* @param x
|
||||
* @param y
|
||||
* @param r pointer to float variable to receive the red component of the pixel's color
|
||||
* @param g pointer to float variable to receive the green component of the pixel's color
|
||||
* @param b pointer to float variable to receive the blue component of the pixel's color
|
||||
* @param a pointer to float variable to receive the alpha component of the pixel's color
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool ReadPixelFloat(int x, int y, float* r, float* g, float* b, float* a) const {
|
||||
return SDL_ReadSurfacePixelFloat(*this, x, y, r, g, b, a);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RemoveSurfaceAlternateImages
|
||||
* @brief Remove all alternate images from the surface.
|
||||
*/
|
||||
void RemoveAlternateImages() const { SDL_RemoveSurfaceAlternateImages(*this); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RotateSurface
|
||||
* @brief Rotate the surface by a specified angle returning a new surface with the rotated image.
|
||||
* @param angle The angle to rotate the surface, in degrees.
|
||||
*/
|
||||
Surface Rotate(float angle) const { return get_or_cache(SDL_RotateSurface(*this, angle), SDL_DestroySurface); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SaveBMP
|
||||
* @brief Save the surface as a BMP image to a file.
|
||||
* @param file The file path to save the BMP image to.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SaveBMP(const char* file) const { return SDL_SaveBMP(*this, file); }
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_SaveBMP_IO
|
||||
*/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SavePNG
|
||||
* @brief Save the surface as a PNG image to a file.
|
||||
* @param file The file path to save the PNG image to.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SavePNG(const char* file) const { return SDL_SavePNG(*this, file); }
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_SavePNG_IO
|
||||
*/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_ScaleSurface
|
||||
* @brief Scale the surface to a new width and height, returning a new surface with the scaled image.
|
||||
* @param w The new width of the surface.
|
||||
* @param h The new height of the surface.
|
||||
* @param scale_mode The scale mode to use for scaling the surface
|
||||
* @return A new Surface instance with the scaled surface, or nullptr on failure.
|
||||
*/
|
||||
Surface Scale(int w, int h, SDL_ScaleMode scale_mode) const {
|
||||
return get_or_cache(SDL_ScaleSurface(*this, w, h, scale_mode), SDL_DestroySurface);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetSurfaceAlphaMod
|
||||
* @brief Set the surface's alpha modulation value.
|
||||
* @param alpha The alpha modulation value to set (0-255).
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetAlphaMod(Uint8 alpha) const { return SDL_SetSurfaceAlphaMod(*this, alpha); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetSurfaceBlendMode
|
||||
* @brief Set the surface's blend mode.
|
||||
* @param blend_mode The blend mode to set for the surface.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetBlendMode(SDL_BlendMode blend_mode) const { return SDL_SetSurfaceBlendMode(*this, blend_mode); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetSurfaceClipRect
|
||||
* @brief Set the surface's clipping rectangle.
|
||||
* @param rect A pointer to an SDL_Rect structure representing the clipping rectangle to set,
|
||||
* or NULL to disable clipping.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetClipRect(const SDL_Rect* rect) const { return SDL_SetSurfaceClipRect(*this, rect); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetSurfaceColorKey
|
||||
* @brief Set the surface's color key.
|
||||
* @param enable Whether to enable or disable the color key for the surface.
|
||||
* @param color_key The color key value to set for the surface.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetColorKey(bool enable, Uint32 color_key) const { return SDL_SetSurfaceColorKey(*this, enable, color_key); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetSurfaceColorMod
|
||||
* @brief Set the surface's color modulation values.
|
||||
* @param r The red color modulation value to set.
|
||||
* @param g The green color modulation value to set.
|
||||
* @param b The blue color modulation value to set.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetColorMod(Uint8 r, Uint8 g, Uint8 b) const { return SDL_SetSurfaceColorMod(*this, r, g, b); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetSurfaceColorspace
|
||||
* @brief Set the surface's colorspace.
|
||||
* @param colorspace The colorspace to set for the surface.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetColorspace(SDL_Colorspace colorspace) const { return SDL_SetSurfaceColorspace(*this, colorspace); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetSurfacePalette
|
||||
* @brief Set the surface's palette.
|
||||
* @param palette A pointer to an SDL_Palette structure representing the palette to set for the surface.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetPalette(SDL_Palette* palette) const { return SDL_SetSurfacePalette(*this, palette); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetSurfaceRLE
|
||||
* @brief Set the surface's RLE acceleration hint.
|
||||
* @param rle The RLE acceleration hint to set for the surface.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetRLE(bool rle) const { return SDL_SetSurfaceRLE(*this, rle); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_StretchSurface
|
||||
* @brief Blits this surface onto a destination rectangle stretching/smooshing the image to fit the destination
|
||||
* rectangle.
|
||||
* @param dst_surface The destination surface to blit on to.
|
||||
* @param dst_rect A pointer to an SDL_Rect structure representing the area on the destination surface to blit
|
||||
* onto, or NULL to blit onto the entire surface.
|
||||
* @param src_rect A pointer to an SDL_Rect structure representing the area of the source surface to blit, or NULL
|
||||
* to blit the entire surface.
|
||||
* @param scale_mode The scale mode to use for scaling the surface when stretching.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool StretchTo(
|
||||
SDL_Surface* dst_surface, const SDL_Rect* dst_rect, const SDL_Rect* src_rect, SDL_ScaleMode scale_mode) const {
|
||||
return SDL_StretchSurface(*this, src_rect, dst_surface, dst_rect, scale_mode);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SurfaceHasAlternateImages
|
||||
* @brief Check if the surface has any alternate images.
|
||||
* @return bool true if the surface has alternate images, false otherwise.
|
||||
*/
|
||||
bool HasAlternateImages() const { return SDL_SurfaceHasAlternateImages(*this); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SurfaceHasColorKey
|
||||
* @brief Check if the surface has a color key.
|
||||
* @return bool true if the surface has a color key, false otherwise.
|
||||
*/
|
||||
bool HasColorKey() const { return SDL_SurfaceHasColorKey(*this); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SurfaceHasRLE
|
||||
* @brief Check if the surface has RLE acceleration enabled.
|
||||
* @return bool true if the surface has RLE acceleration enabled, false otherwise.
|
||||
*/
|
||||
bool HasRLE() const { return SDL_SurfaceHasRLE(*this); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_UnlockSurface
|
||||
* @brief Unlock the surface after direct pixel access.
|
||||
*/
|
||||
void Unlock() const { SDL_UnlockSurface(*this); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_WriteSurfacePixel
|
||||
* @brief Write a pixel to the surface at the specified coordinates with the given color value.
|
||||
* @param x
|
||||
* @param y
|
||||
* @param r
|
||||
* @param g
|
||||
* @param b
|
||||
* @param a
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool WritePixel(int x, int y, Uint8 r, Uint8 g, Uint8 b, Uint8 a) const {
|
||||
return SDL_WriteSurfacePixel(*this, x, y, r, g, b, a);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_WriteSurfacePixelFloat
|
||||
* @brief Write a pixel to the surface at the specified coordinates with the given color value as floats.
|
||||
* @param x
|
||||
* @param y
|
||||
* @param r
|
||||
* @param g
|
||||
* @param b
|
||||
* @param a
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool WritePixelFloat(int x, int y, float r, float g, float b, float a) const {
|
||||
return SDL_WriteSurfacePixelFloat(*this, x, y, r, g, b, a);
|
||||
}
|
||||
};
|
||||
}
|
||||
@@ -5,36 +5,457 @@
|
||||
*/
|
||||
#include <SDL3/SDL.h>
|
||||
#include <hdk/grid/SharedPtrWrapper.hpp>
|
||||
#include <hdk/sdl/Properties.hpp>
|
||||
/** Windows are the primary interface for rendering and interacting with the user in SDL */
|
||||
namespace hdk::sdl {
|
||||
class Window : public hdk::grid::SharedPtrWrapper<SDL_Window> {
|
||||
public:
|
||||
/** Inherit constructors from SharedPtrWrapper */
|
||||
using hdk::grid::SharedPtrWrapper<SDL_Window>::SharedPtrWrapper;
|
||||
/**
|
||||
* https://wiki.libsdl.org/SDL3/SDL_CreateWindow
|
||||
* https://wiki.libsdl.org/SDL3/SDL_DestroyWindowSurface
|
||||
*
|
||||
* @param title The title of the window, in UTF-8 encoding. If the title contains UTF-8 characters, you should use SDL_CreateWindowUTF8() instead.
|
||||
* @param w The width of the window in pixels.
|
||||
* @param h The height of the window in pixels.
|
||||
* @param flags 0, or one or more SDL_WindowFlags OR'd together.
|
||||
* @return A Window instance that manages the created SDL_Window. If window creation fails, the returned Window will evaluate to false (i.e., it will be null).
|
||||
*/
|
||||
static Window Create(const char* title, int w, int h, SDL_WindowFlags flags)
|
||||
{
|
||||
class Renderer;
|
||||
class Window : public hdk::grid::SharedPtrWrapper<SDL_Window> {
|
||||
public:
|
||||
friend class Renderer;
|
||||
friend std::pair<Window, Renderer> CreateWindowAndRenderer(const char* title, int width, int height, SDL_WindowFlags window_flags);
|
||||
/** Inherit constructors from SharedPtrWrapper */
|
||||
using hdk::grid::SharedPtrWrapper<SDL_Window>::SharedPtrWrapper;
|
||||
/**
|
||||
* https://wiki.libsdl.org/SDL3/SDL_CreateWindow
|
||||
* https://wiki.libsdl.org/SDL3/SDL_DestroyWindowSurface
|
||||
*
|
||||
* @param title The title of the window
|
||||
* @param w The width of the window in pixels.
|
||||
* @param h The height of the window in pixels.
|
||||
* @param flags 0, or one or more SDL_WindowFlags OR'd together.
|
||||
* @return A Window instance that manages the created SDL_Window. If window creation fails, the returned Window
|
||||
* will evaluate to false (i.e., it will be null).
|
||||
*/
|
||||
static Window Create(const char* title, int w, int h, SDL_WindowFlags flags) {
|
||||
return Window(get_or_cache(SDL_CreateWindow(title, w, h, flags), SDL_DestroyWindow));
|
||||
}
|
||||
/**
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetWindowFromID
|
||||
* @brief Get window for WindowID
|
||||
* @param id The ID of the window.
|
||||
* @return A Window instance that wraps the SDL_Window. If no window with the given ID exists, the returned Window will evaluate to false (i.e., it will be null).
|
||||
*/
|
||||
static Window GetFromID(SDL_WindowID id)
|
||||
{
|
||||
/** Because it is possible windows were created by other means, we use get_or_view to wrap the SDL_Window without taking ownership */
|
||||
}
|
||||
/** @see SDL_CreateWindowWithProperties
|
||||
* https://wiki.libsdl.org/SDL3/SDL_CreateWindowWithProperties
|
||||
* @brief Create a window with properties.
|
||||
* @param propertiesID The ID of the properties set to use for the window.
|
||||
* @return Window The created window. If the creation fails, returns an invalid window.
|
||||
*/
|
||||
static Window CreateWithProperties(
|
||||
SDL_PropertiesID propertiesID) {
|
||||
return Window(
|
||||
get_or_cache(SDL_CreateWindowWithProperties(propertiesID), SDL_DestroyWindow));
|
||||
}
|
||||
/**
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetWindowFromID
|
||||
* @brief Get window for WindowID
|
||||
* @param id The ID of the window.
|
||||
* @return A Window instance that wraps the SDL_Window. If no window with the given ID exists, the returned Window
|
||||
* will evaluate to false (i.e., it will be null).
|
||||
*/
|
||||
static Window GetFromID(SDL_WindowID id) {
|
||||
/** Because it is possible windows were created by other means, we use get_or_view to wrap the SDL_Window
|
||||
* without taking ownership */
|
||||
return Window(get_or_view(SDL_GetWindowFromID(id)));
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
/**
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetGrabbedWindow
|
||||
* @brief Get the currently grabbed window, if any.
|
||||
* @return A Window instance that wraps the currently grabbed SDL_Window. If no window is
|
||||
*/
|
||||
static Window GetGrabbed() {
|
||||
/** Because it is possible windows were created by other means, we use get_or_view to wrap the SDL_Window
|
||||
* without taking ownership */
|
||||
return Window(get_or_view(SDL_GetGrabbedWindow()));
|
||||
}
|
||||
|
||||
public: // Instance Properties
|
||||
/**
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetWindowAspectRatio
|
||||
* @brief Get the aspect ratio of the window.
|
||||
* @param min_aspect_ratio A pointer to a float that will be filled with the minimum aspect ratio of the window.
|
||||
* @param max_aspect_ratio A pointer to a float that will be filled with the
|
||||
* @return bool True if the aspect ratio was successfully retrieved, false otherwise.
|
||||
*/
|
||||
bool GetAspectRatio(float* min_aspect_ratio, float* max_aspect_ratio) const {
|
||||
return SDL_GetWindowAspectRatio(*this, min_aspect_ratio, max_aspect_ratio);
|
||||
}
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetWindowBordersSize
|
||||
* @brief Get the size of the window borders.
|
||||
* @param top A pointer to an int that will be filled with the size of the top border of the window.
|
||||
* @param left A pointer to an int that will be filled with the size of the left border of the window.
|
||||
* @param bottom A pointer to an int that will be filled with the size of the bottom border of the window.
|
||||
* @param right A pointer to an int that will be filled with the size of the right border of the window.
|
||||
* @return bool True if the border sizes were successfully retrieved, false otherwise.
|
||||
*/
|
||||
bool GetBordersSize(int* top, int* left, int* bottom, int* right) const {
|
||||
return SDL_GetWindowBordersSize(*this, top, left, bottom, right);
|
||||
}
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetWindowDisplayScale
|
||||
* @brief Get the display scale of the window.
|
||||
* @return float The display scale of the window. If the window is invalid, returns 0.0f.
|
||||
*/
|
||||
float GetDisplayScale() const { return SDL_GetWindowDisplayScale(*this); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetWindowFlags
|
||||
* @brief Get the flags of the window.
|
||||
* @return SDL_WindowFlags The flags of the window. If the window is invalid, returns 0.
|
||||
*/
|
||||
SDL_WindowFlags GetFlags() const { return SDL_GetWindowFlags(*this); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetWindowFullscreenMode
|
||||
* @brief Get the fullscreen mode of the window.
|
||||
* @return const SDL_DisplayMode* A pointer to an SDL_DisplayMode structure that will be filled with the
|
||||
* fullscreen mode of the window. If the window is not in fullscreen mode or is invalid, returns nullptr.
|
||||
*/
|
||||
const SDL_DisplayMode* GetFullscreenMode() const { return SDL_GetWindowFullscreenMode(*this); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetWindowID
|
||||
* @brief Get the ID of the window.
|
||||
* @return SDL_WindowID The ID of the window. If the window is invalid, returns 0.
|
||||
*/
|
||||
SDL_WindowID GetID() const { return SDL_GetWindowID(*this); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetWindowKeyboardGrab
|
||||
* @brief Get the keyboard grab state of the window.
|
||||
* @return SDL_bool True if the window has grabbed the keyboard, false otherwise.
|
||||
*/
|
||||
bool GetKeyboardGrab() const { return SDL_GetWindowKeyboardGrab(*this); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_SetWindowKeyboardGrab
|
||||
* @brief Set the keyboard grab state of the window.
|
||||
* @param grabbed True to grab the keyboard, false to release it.
|
||||
* @return bool True if the keyboard grab state was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetKeyboardGrab(bool grabbed) const { return SDL_SetWindowKeyboardGrab(*this, grabbed); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetWindowMouseGrab
|
||||
* @brief Get the mouse grab state of the window.
|
||||
* @return SDL_bool True if the window has grabbed the mouse, false otherwise.
|
||||
*/
|
||||
bool GetMouseGrab() const { return SDL_GetWindowMouseGrab(*this); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_SetWindowMouseGrab
|
||||
* @brief Set the mouse grab state of the window.
|
||||
* @param grabbed True to grab the mouse, false to release it.
|
||||
* @return bool True if the mouse grab state was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetMouseGrab(bool grabbed) const { return SDL_SetWindowMouseGrab(*this, grabbed); }
|
||||
/** SDL_GetWindowMouseRect
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetWindowMouseRect
|
||||
* @brief Get the mouse rectangle of the window.
|
||||
* @return const SDL_Rect* A pointer to an SDL_Rect structure that will be filled with the mouse rectangle of the
|
||||
* window. If the window is invalid, returns nullptr.
|
||||
*/
|
||||
const SDL_Rect* GetMouseRect() const { return SDL_GetWindowMouseRect(*this); }
|
||||
/** @see SDL_SetWindowMouseRect
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetWindowMouseRect
|
||||
* @brief Set the mouse rectangle of the window.
|
||||
* @param rect A pointer to an SDL_Rect structure that defines the mouse rectangle of the window.
|
||||
* @return bool True if the mouse rectangle was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetMouseRect(const SDL_Rect* rect) const { return SDL_SetWindowMouseRect(*this, rect); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetWindowMaximumSize
|
||||
* @brief Get the maximum size of the window.
|
||||
* @param w A pointer to an int that will be filled with the maximum width of the window.
|
||||
* @param h A pointer to an int that will be filled with the maximum height of the window.
|
||||
* @return bool True if the maximum size was successfully retrieved, false otherwise.
|
||||
*/
|
||||
bool GetMaximumSize(int* w, int* h) const { return SDL_GetWindowMaximumSize(*this, w, h); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_SetWindowMaximumSize
|
||||
* @brief Set the maximum size of the window.
|
||||
* @param w The maximum width of the window in pixels.
|
||||
* @param h The maximum height of the window in pixels.
|
||||
* @return bool True if the maximum size was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetMaximumSize(int w, int h) const { return SDL_SetWindowMaximumSize(*this, w, h); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetWindowMinimumSize
|
||||
* @brief Get the minimum size of the window.
|
||||
* @param w A pointer to an int that will be filled with the minimum width of the window.
|
||||
* @param h A pointer to an int that will be filled with the minimum height of the window.
|
||||
* @return bool True if the minimum size was successfully retrieved, false otherwise.
|
||||
*/
|
||||
bool GetMinimumSize(int* w, int* h) const { return SDL_GetWindowMinimumSize(*this, w, h); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_SetWindowMinimumSize
|
||||
* @brief Set the minimum size of the window.
|
||||
* @param w The minimum width of the window in pixels.
|
||||
* @param h The minimum height of the window in pixels.
|
||||
* @return bool True if the minimum size was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetMinimumSize(int w, int h) const { return SDL_SetWindowMinimumSize(*this, w, h); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_SetWindowSize
|
||||
* @brief Set the size of the window.
|
||||
* @param w The width of the window in pixels.
|
||||
* @param h The height of the window in pixels.
|
||||
* @return bool True if the size was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetSize(int w, int h) const { return SDL_SetWindowSize(*this, w, h); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetWindowSize
|
||||
* @brief Get the size of the window.
|
||||
* @param w A pointer to an int that will be filled with the width of the window.
|
||||
* @param h A pointer to an int that will be filled with the height of the window.
|
||||
* @return bool True if the size was successfully retrieved, false otherwise.
|
||||
*/
|
||||
bool GetSize(int* w, int* h) const { return SDL_GetWindowSize(*this, w, h); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetWindowSafeArea
|
||||
* @brief Get the safe area of the window.
|
||||
* @param rect A pointer to an SDL_Rect structure that will be filled with the safe area of the window. If the
|
||||
* window is invalid, the rect will be set to {0, 0, 0, 0}.
|
||||
* @return bool True if the safe area was successfully retrieved, false otherwise.
|
||||
*/
|
||||
bool GetSafeArea(SDL_Rect* rect) const { return SDL_GetWindowSafeArea(*this, rect); }
|
||||
/** @see SDL_GetWindowOpacity
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetWindowOpacity
|
||||
* @brief Get the opacity of the window.
|
||||
* @return float The opacity of the window. If the window is invalid, returns 0.0f.
|
||||
*/
|
||||
float GetOpacity() const { return SDL_GetWindowOpacity(*this); }
|
||||
/** @see SDL_SetWindowOpacity
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetWindowOpacity
|
||||
* @brief Set the opacity of the window.
|
||||
* @param opacity The opacity of the window, between 0.0f and 1.0f. If the window is invalid, this function will
|
||||
* return false.
|
||||
* @return bool True if the opacity was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetOpacity(float opacity) const { return SDL_SetWindowOpacity(*this, opacity); }
|
||||
/** @see SDL_GetWindowParent
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetWindowParent
|
||||
* @brief Get the parent of the window.
|
||||
* @return Window The parent of the window. If the window has no parent or is invalid, returns a Window that
|
||||
* evaluates to false (i.e., it will be null).
|
||||
*/
|
||||
Window GetParent() const {
|
||||
/** Because it is possible windows were created by other means, we use get_or_view to wrap the SDL_Window
|
||||
* without taking ownership */
|
||||
return Window(get_or_view(SDL_GetWindowParent(*this)));
|
||||
}
|
||||
/** @see SDL_SetWindowParent
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetWindowParent
|
||||
* @brief Set the parent of the window.
|
||||
* @param parent The parent window. If the window is invalid, this function will return false.
|
||||
* @return bool True if the parent was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetParent(SDL_Window* parent) const { return SDL_SetWindowParent(*this, parent); }
|
||||
/** @see SDL_GetWindowPixelDensity
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetWindowPixelDensity
|
||||
* @brief Get the pixel density of the window.
|
||||
* @return float The pixel density of the window. If the window is invalid, returns 0.0f.
|
||||
*/
|
||||
float GetPixelDensity() const { return SDL_GetWindowPixelDensity(*this); }
|
||||
/** @see SDL_GetWindowSurfaceVSync
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetWindowSurfaceVSync
|
||||
* @brief Get current vertical refresh sync interval.
|
||||
* @param vsync pointer to existing int to be filled with the current vertical refresh sync interval. If the
|
||||
* window is invalid, this function will return false and vsync will be set to 0.
|
||||
* @return bool True if the vertical refresh sync interval was successfully retrieved, false otherwise.
|
||||
*/
|
||||
bool GetSurfaceVSync(int* vsync) const { return SDL_GetWindowSurfaceVSync(*this, vsync); }
|
||||
/** @see SDL_SetWindowSurfaceVSync
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetWindowSurfaceVSync
|
||||
* @brief Set vertical refresh sync interval.
|
||||
* @param vsync The vertical refresh sync interval. If the window is invalid, this function will return false.
|
||||
* @return bool True if the vertical refresh sync interval was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetSurfaceVSync(int vsync) const { return SDL_SetWindowSurfaceVSync(*this, vsync); }
|
||||
/** @see SDL_GetWindowPixelFormat
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetWindowPixelFormat
|
||||
* @brief Get the pixel format of the window.
|
||||
* @return Uint32 The pixel format of the window. If the window is invalid, returns 0.
|
||||
*/
|
||||
SDL_PixelFormat GetPixelFormat() const { return SDL_GetWindowPixelFormat(*this); }
|
||||
/** @see SDL_GetWindowPosition
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetWindowPosition
|
||||
* @brief Get the position of the window.
|
||||
* @param x Pointer to an int to be filled with the x position of the window. If the window is invalid, this
|
||||
* function will return false and x will be set to 0.
|
||||
* @param y Pointer to an int to be filled with the y position of the window. If the window is invalid, this
|
||||
* function will return false and y will be set to 0.
|
||||
* @return bool True if the position was successfully retrieved, false otherwise.
|
||||
*/
|
||||
bool GetPosition(int* x, int* y) const { return SDL_GetWindowPosition(*this, x, y); }
|
||||
/** @see SDL_SetWindowPosition
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetWindowPosition
|
||||
* @brief Set the position of the window.
|
||||
* @param x The x position of the window in pixels. If the window is invalid, this function will return false.
|
||||
* @param y The y position of the window in pixels. If the window is invalid, this function will return false.
|
||||
* @return bool True if the position was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetPosition(int x, int y) const { return SDL_SetWindowPosition(*this, x, y); }
|
||||
/** @see SDL_GetWindowProgressState
|
||||
* @see SDL_ProgressState
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetWindowProgressState
|
||||
* @brief Get the progress state of the window.
|
||||
* @return The progress state of the window. If the window is invalid, returns 0.
|
||||
*/
|
||||
SDL_ProgressState GetProgressState() const { return SDL_GetWindowProgressState(*this); }
|
||||
/** @see SDL_SetWindowProgressState
|
||||
* @see SDL_ProgressState
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetWindowProgressState
|
||||
* @brief Set the progress state of the window.
|
||||
* @param state The progress state of the window. If the window is invalid, this function will return false.
|
||||
* @return bool True if the progress state was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetProgressState(SDL_ProgressState state) const { return SDL_SetWindowProgressState(*this, state); }
|
||||
|
||||
/** @see SDL_GetWindowProgressValue
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetWindowProgressValue
|
||||
* @brief Get the progress value of the window.
|
||||
* @return float The progress value of the window, between 0.0f and 1.0f. If the window is invalid, returns 0.0f.
|
||||
*/
|
||||
float GetProgressValue() const { return SDL_GetWindowProgressValue(*this); }
|
||||
/** @see SDL_SetWindowProgressValue
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetWindowProgressValue
|
||||
* @brief Set the progress value of the window.
|
||||
* @param value The progress value of the window, between 0.0f and 1.0f. If the window is invalid, this function
|
||||
* will return false.
|
||||
* @return bool True if the progress value was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetProgressValue(float value) const { return SDL_SetWindowProgressValue(*this, value); }
|
||||
/** @see SDL_GetWindowProperties
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetWindowProperties
|
||||
* @brief Get the properties set of the window.
|
||||
* @return Properties The properties set of the window. If the window is invalid, returns an empty properties set.
|
||||
*/
|
||||
Properties GetProperties() const { return Properties(SDL_GetWindowProperties(*this)); }
|
||||
/** @see SDL_GetRenderer
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetRenderer
|
||||
* @brief Get the renderer associated with the window.
|
||||
* @return Renderer The renderer associated with the window. If the window is invalid, returns nullptr.
|
||||
*/
|
||||
Renderer GetRenderer() const;
|
||||
/** @see SDL_GetWindowTitle
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetWindowTitle
|
||||
* @brief Get the title of the window.
|
||||
* @return const char* The title of the window. If the window is invalid, returns an empty string.
|
||||
*/
|
||||
const char* GetTitle() const { return SDL_GetWindowTitle(*this); }
|
||||
/** @see SDL_SetWindowTitle
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetWindowTitle
|
||||
* @brief Set the title of the window.
|
||||
* @param title The title of the window. If the window is invalid, this function will return false.
|
||||
* @return bool True if the title was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetTitle(const char* title) const { return SDL_SetWindowTitle(*this, title); }
|
||||
/** @see SDL_SetWindowAlwaysOnTop
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetWindowAlwaysOnTop
|
||||
* @brief Set the window to be always on top.
|
||||
* @param alwaysOnTop True to make the window always on top, false otherwise.
|
||||
* @return bool True if the operation was successful, false otherwise.
|
||||
*/
|
||||
bool SetAlwaysOnTop(bool alwaysOnTop) const { return SDL_SetWindowAlwaysOnTop(*this, alwaysOnTop); }
|
||||
/** @see SDL_SetWindowIcon
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetWindowIcon
|
||||
* @brief Set the icon of the window.
|
||||
* @param icon The surface to use as the window's icon. If the window is invalid, this function will return false.
|
||||
* @return bool True if the icon was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetIcon(SDL_Surface* icon) const { return SDL_SetWindowIcon(*this, icon); }
|
||||
/** @see SDL_SetWindowModal
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetWindowModal
|
||||
* @brief Set the window to be modal.
|
||||
* @param modal True to make the window modal, false otherwise.
|
||||
* @return bool True if the operation was successful, false otherwise.
|
||||
*/
|
||||
bool SetModal(bool modal) const { return SDL_SetWindowModal(*this, modal); }
|
||||
/** @see SDL_SetWindowResizable
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetWindowResizable
|
||||
* @brief Set the window to be resizable.
|
||||
* @param resizable True to make the window resizable, false otherwise.
|
||||
* @return bool True if the operation was successful, false otherwise.
|
||||
*/
|
||||
bool SetResizable(bool resizable) const { return SDL_SetWindowResizable(*this, resizable); }
|
||||
/** @see SDL_SetWindowShape
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetWindowShape
|
||||
* @brief Set the shape of the window.
|
||||
* @param shape The shape mode to set for the window. If the window is invalid, this function will return false.
|
||||
* @return bool True if the shape was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetShape(SDL_Surface* shape) const { return SDL_SetWindowShape(*this, shape); }
|
||||
/** @see SDL_CreatePopupWindow
|
||||
* https://wiki.libsdl.org/SDL3/SDL_CreatePopupWindow
|
||||
* @brief Create a popup window.
|
||||
* @param offset_x The x position of the popup window relative to the parent window.
|
||||
* @param offset_y The y position of the popup window relative to the parent window.
|
||||
* @param w The width of the popup window.
|
||||
* @param h The height of the popup window.
|
||||
* @param flags The flags for the popup window.
|
||||
* @return Window The created popup window. If the creation fails, returns an invalid window.
|
||||
*/
|
||||
Window CreatePopup(int offset_x, int offset_y, int w, int h, SDL_WindowFlags flags) const {
|
||||
return Window(
|
||||
get_or_cache(SDL_CreatePopupWindow(*this, offset_x, offset_y, w, h, flags), SDL_DestroyWindow));
|
||||
}
|
||||
/** @see SDL_DestroyWindowSurface
|
||||
* https://wiki.libsdl.org/SDL3/SDL_DestroyWindowSurface
|
||||
* @brief Destroy the window surface.
|
||||
* @return bool True if the surface was successfully destroyed, false otherwise.
|
||||
*/
|
||||
bool DestroySurface() const { return SDL_DestroyWindowSurface(*this); }
|
||||
/** @see SDL_FlashWindow
|
||||
* https://wiki.libsdl.org/SDL3/SDL_FlashWindow
|
||||
* @brief Flash the window to get the user's attention.
|
||||
* @param flashType The type of flash to perform.
|
||||
* @return bool True if the window was successfully flashed, false otherwise.
|
||||
*/
|
||||
bool Flash(SDL_FlashOperation flashType) const { return SDL_FlashWindow(*this, flashType); }
|
||||
/** @see SDL_HideWindow
|
||||
* https://wiki.libsdl.org/SDL3/SDL_HideWindow
|
||||
* @brief Hide the window.
|
||||
* @return bool True if the window was successfully hidden, false otherwise.
|
||||
*/
|
||||
bool Hide() const { return SDL_HideWindow(*this); }
|
||||
/** @see SDL_MaximizeWindow
|
||||
* https://wiki.libsdl.org/SDL3/SDL_MaximizeWindow
|
||||
* @brief Maximize the window. If the window is already maximized, this function will return false.
|
||||
* @return bool True if the window was successfully maximized, false otherwise.
|
||||
*/
|
||||
bool Maximize() const { return SDL_MaximizeWindow(*this); }
|
||||
/** @see SDL_MinimizeWindow
|
||||
* https://wiki.libsdl.org/SDL3/SDL_MinimizeWindow
|
||||
* @brief Minimize the window. If the window is already minimized, this function will
|
||||
* return false.
|
||||
* @return bool True if the window was successfully minimized, false otherwise.
|
||||
*/
|
||||
bool Minimize() const { return SDL_MinimizeWindow(*this); }
|
||||
/** @see SDL_RaiseWindow
|
||||
* https://wiki.libsdl.org/SDL3/SDL_RaiseWindow
|
||||
* @brief Raise the window above other windows. If the window is already raised, this function will return false.
|
||||
* @return bool True if the window was successfully raised, false otherwise.
|
||||
*/
|
||||
bool Raise() const { return SDL_RaiseWindow(*this); }
|
||||
/** @see SDL_RestoreWindow
|
||||
* https://wiki.libsdl.org/SDL3/SDL_RestoreWindow
|
||||
* @brief Restore the window to its normal size and position. If the window is not minimized or maximized, this
|
||||
* function will return false.
|
||||
* @return bool True if the window was successfully restored, false otherwise.
|
||||
*/
|
||||
bool Restore() const { return SDL_RestoreWindow(*this); }
|
||||
/** @see SDL_ShowWindow
|
||||
* https://wiki.libsdl.org/SDL3/SDL_ShowWindow
|
||||
* @brief Show the window.
|
||||
* @return bool True if the window was successfully shown, false otherwise.
|
||||
*/
|
||||
bool Show() const { return SDL_ShowWindow(*this); }
|
||||
/** @see SDL_ShowWindowSystemMenu
|
||||
* https://wiki.libsdl.org/SDL3/SDL_ShowWindowSystemMenu
|
||||
* @brief Show the window's system menu.
|
||||
* @param x
|
||||
* @param y
|
||||
* @return bool True if the system menu was successfully shown, false otherwise.
|
||||
*/
|
||||
bool ShowSystemMenu(int x, int y) const { return SDL_ShowWindowSystemMenu(*this, x, y); }
|
||||
/** @see SDL_SyncWindow
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SyncWindow
|
||||
* @brief Sync the window's state with the display. This is useful after changing display modes or other
|
||||
* operations that may affect the window's appearance.
|
||||
* @return bool True if the window was successfully synced, false otherwise.
|
||||
*/
|
||||
bool Sync() const { return SDL_SyncWindow(*this); }
|
||||
/** @see SDL_UpdateWindowSurface
|
||||
* https://wiki.libsdl.org/SDL3/SDL_UpdateWindowSurface
|
||||
* @brief Update the window surface with any changes made to the surface. This should only be used if you are
|
||||
* using the window surface for rendering. If the window is invalid, this function will return false.
|
||||
* @return bool True if the window surface was successfully updated, false otherwise.
|
||||
*/
|
||||
bool UpdateSurface() const { return SDL_UpdateWindowSurface(*this); }
|
||||
/** @see SDL_UpdateWindowSurfaceRects
|
||||
* https://wiki.libsdl.org/SDL3/SDL_UpdateWindowSurfaceRects
|
||||
* @brief Update the window surface with any changes made to the specified rectangles on the surface. This should
|
||||
* only be used if you are using the window surface for rendering. If the window is invalid, this function will
|
||||
* return false.
|
||||
* @param rects An array of SDL_Rect structures that define the rectangles to update on the window surface.
|
||||
* @param num_rects The number of rectangles in the rects array.
|
||||
* @return bool True if the window surface was successfully updated, false otherwise.
|
||||
*/
|
||||
bool UpdateSurfaceRects(const SDL_Rect* rects, int num_rects) const {
|
||||
return SDL_UpdateWindowSurfaceRects(*this, rects, num_rects);
|
||||
}
|
||||
};
|
||||
} // namespace hdk::sdl
|
||||
Reference in New Issue
Block a user