Pixels, Surfaces, Renderer, oh my...
This commit is contained in:
BadQuanta
@@ -0,0 +1,27 @@
|
||||
#pragma once
|
||||
#include <SDL3/SDL.h>
|
||||
/// @file Application.hpp
|
||||
/// For complete documentation, see src/Application.cpp
|
||||
namespace hdk::sdl {
|
||||
/** SDL Requires this interface to be implemented by the application class. */
|
||||
class AppInterface {
|
||||
public:
|
||||
virtual SDL_AppResult Event(SDL_Event* event) = 0;
|
||||
virtual SDL_AppResult Init(int argc, char* argv[]) = 0;
|
||||
virtual SDL_AppResult Iterate() = 0;
|
||||
virtual void Quit(SDL_AppResult code) = 0;
|
||||
};
|
||||
/** I'm calling it a public application because the AppStatus member is publicly accessible and so can be
|
||||
* modified directly by the rest of application logic that has access to this application instance via this subclass.
|
||||
*/
|
||||
class PublicApp : public AppInterface {
|
||||
public:
|
||||
SDL_AppResult AppStatus { SDL_APP_CONTINUE };
|
||||
virtual SDL_AppResult Event(SDL_Event* event) override { return AppStatus; }
|
||||
virtual SDL_AppResult Init(int argc, char* argv[]) override { return AppStatus; }
|
||||
virtual SDL_AppResult Iterate() override { return AppStatus; }
|
||||
virtual void Quit(SDL_AppResult code) override {
|
||||
// Default quit behavior is to do nothing, allowing the app to control its own lifetime.
|
||||
}
|
||||
};
|
||||
} // namespace hdk::sdl
|
||||
@@ -0,0 +1,96 @@
|
||||
#pragma once
|
||||
#include <SDL3/SDL_log.h>
|
||||
namespace hdk::sdl {
|
||||
/**
|
||||
* @brief Log instances represent logging categories: Application, Error, System, Audio, Video, Render, Input, Test,
|
||||
* etc.
|
||||
*/
|
||||
class Log {
|
||||
public:
|
||||
const int category;
|
||||
static const Log Application;
|
||||
Log(int category)
|
||||
: category(category) { }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetDefaultLogOutputFunction */
|
||||
static SDL_LogOutputFunction GetDefaultOutputFunction() { return SDL_GetDefaultLogOutputFunction(); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetLogOutputFunction */
|
||||
static void GetOutputFunction(SDL_LogOutputFunction* callback, void** userdata) {
|
||||
SDL_GetLogOutputFunction(callback, userdata);
|
||||
}
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetLogPriority */
|
||||
SDL_LogPriority GetPriority() { return SDL_GetLogPriority(category); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_Log */
|
||||
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_LogCritical */
|
||||
void Critical(const char* fmt, ...) const {
|
||||
va_list args;
|
||||
va_start(args, fmt);
|
||||
LogMessageV(SDL_LOG_PRIORITY_CRITICAL, fmt, args);
|
||||
va_end(args);
|
||||
}
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_LogDebug */
|
||||
void Debug(const char* fmt, ...) const {
|
||||
va_list args;
|
||||
va_start(args, fmt);
|
||||
LogMessageV(SDL_LOG_PRIORITY_DEBUG, fmt, args);
|
||||
va_end(args);
|
||||
}
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_LogError */
|
||||
void Error(const char* fmt, ...) const {
|
||||
va_list args;
|
||||
va_start(args, fmt);
|
||||
LogMessageV(SDL_LOG_PRIORITY_ERROR, fmt, args);
|
||||
va_end(args);
|
||||
}
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_LogInfo */
|
||||
void Info(const char* fmt, ...) const {
|
||||
va_list args;
|
||||
va_start(args, fmt);
|
||||
LogMessageV(SDL_LOG_PRIORITY_INFO, fmt, args);
|
||||
va_end(args);
|
||||
}
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_LogMessage */
|
||||
void LogMessage(SDL_LogPriority priority, const char* fmt, ...) const {
|
||||
va_list args;
|
||||
va_start(args, fmt);
|
||||
LogMessageV(priority, fmt, args);
|
||||
va_end(args);
|
||||
}
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_LogMessageV */
|
||||
void LogMessageV(SDL_LogPriority priority, const char* fmt, va_list args) const {
|
||||
SDL_LogMessageV(category, priority, fmt, args);
|
||||
}
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_LogTrace */
|
||||
void Trace(const char* fmt, ...) const {
|
||||
va_list args;
|
||||
va_start(args, fmt);
|
||||
LogMessageV(SDL_LOG_PRIORITY_TRACE, fmt, args);
|
||||
va_end(args);
|
||||
}
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_LogVerbose */
|
||||
void Verbose(const char* fmt, ...) const {
|
||||
va_list args;
|
||||
va_start(args, fmt);
|
||||
LogMessageV(SDL_LOG_PRIORITY_VERBOSE, fmt, args);
|
||||
va_end(args);
|
||||
}
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_LogWarn */
|
||||
void Warn(const char* fmt, ...) const {
|
||||
va_list args;
|
||||
va_start(args, fmt);
|
||||
LogMessageV(SDL_LOG_PRIORITY_WARN, fmt, args);
|
||||
va_end(args);
|
||||
}
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_ResetLogPriorities */
|
||||
static void ResetPriorities() { SDL_ResetLogPriorities(); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_SetLogOutputFunction */
|
||||
static void SetOutputFunction(SDL_LogOutputFunction callback, void* userdata) { SDL_SetLogOutputFunction(callback, userdata); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_SetLogPriorities */
|
||||
static void SetPriorities(SDL_LogPriority priority) { SDL_SetLogPriorities(priority); }
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_SetLogPriority */
|
||||
void SetPriority(SDL_LogPriority priority) { SDL_SetLogPriority(category, priority); }
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_SetLogPriorityPrefix */
|
||||
// static Log Application(){static Log app(SDL_LOG_CATEGORY_APPLICATION); return app;}
|
||||
};
|
||||
const Log Log::Application(SDL_LOG_CATEGORY_APPLICATION);
|
||||
}
|
||||
@@ -1,176 +1,52 @@
|
||||
#pragma once
|
||||
/**
|
||||
* @file Properties.hpp
|
||||
* @brief Properties are a set of values represented by a single ID.
|
||||
*/
|
||||
/// @file Properties.hpp
|
||||
/// For complete documentation, see src/Properties.cpp
|
||||
#include <SDL3/SDL_properties.h>
|
||||
#include <hdk/grid/PrimitiveWrapper.hpp>
|
||||
/** Many SDL objects have associated properties. */
|
||||
namespace hdk::sdl {
|
||||
class Properties : public grid::PrimitiveWrapper<SDL_PropertiesID> {
|
||||
public:
|
||||
using grid::PrimitiveWrapper<SDL_PropertiesID>::PrimitiveWrapper;
|
||||
|
||||
/** @see SDL_CreateProperties
|
||||
* https://wiki.libsdl.org/SDL3/SDL_CreateProperties
|
||||
* @brief Creates a new properties set.
|
||||
* @return Properties A new properties set.
|
||||
*/
|
||||
static Properties Create() { return Properties(SDL_CreateProperties()); }
|
||||
/** @see SDL_ClearProperty
|
||||
* https://wiki.libsdl.org/SDL3/SDL_ClearProperty
|
||||
* @brief Clears a property from a properties set.
|
||||
* @param name
|
||||
* @return bool True on success, false on failure.
|
||||
**/
|
||||
bool ClearProperty(const char* name) const { return SDL_ClearProperty(*this, name); }
|
||||
/** @see SDL_CopyProperties
|
||||
* https://wiki.libsdl.org/SDL3/SDL_CopyProperties
|
||||
* @brief Copies a properties set.
|
||||
* @return bool True on success, false on failure.
|
||||
*/
|
||||
bool CopyAllTo(SDL_PropertiesID destination) const { return SDL_CopyProperties(*this, destination); }
|
||||
bool CopyAllFrom(SDL_PropertiesID source) { return SDL_CopyProperties(source, *this); }
|
||||
/** @see SDL_DestroyProperties
|
||||
* https://wiki.libsdl.org/SDL3/SDL_DestroyProperties
|
||||
* @brief Destroys a properties set.
|
||||
*/
|
||||
void Destroy() {
|
||||
SDL_DestroyProperties(*this);
|
||||
*this = 0;
|
||||
}
|
||||
/** @see SDL_EnumerateProperties
|
||||
* https://wiki.libsdl.org/SDL3/SDL_EnumerateProperties
|
||||
* @brief Enumerates properties in a properties set.
|
||||
* @param callback An `SDL_EnumeratePropertiesCallback` function pointer.
|
||||
* @param callback_data Void pointer that is passed to the callback function.
|
||||
* @return bool True on success, false on failure.
|
||||
*/
|
||||
bool EnumerateProperties(SDL_EnumeratePropertiesCallback callback, void* callback_data) const {
|
||||
return SDL_EnumerateProperties(*this, callback, callback_data);
|
||||
}
|
||||
/** @see SDL_GetBooleanProperty
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetBooleanProperty
|
||||
* @brief Gets a boolean property from a properties set.
|
||||
* @param name The name of the property.
|
||||
* @param default_value The default value to return if the property does not exist.
|
||||
* @return bool The value of the property.
|
||||
*/
|
||||
bool GetBooleanProperty(const char* name, bool default_value) const {
|
||||
return SDL_GetBooleanProperty(*this, name, default_value);
|
||||
}
|
||||
/** @see SDL_GetFloatProperty
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetFloatProperty
|
||||
* @brief Gets a float property from a properties set.
|
||||
* @param name The name of the property.
|
||||
* @param default_value The default value to return if the property does not exist.
|
||||
* @return float The value of the property.
|
||||
*/
|
||||
float GetFloatProperty(const char* name, float default_value) const {
|
||||
return SDL_GetFloatProperty(*this, name, default_value);
|
||||
}
|
||||
/** @see SDL_GetGlobalProperties
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetGlobalProperties
|
||||
* @brief Gets the global properties set.
|
||||
* @return SDL_PropertiesID The global properties set.
|
||||
*/
|
||||
static Properties GetGlobalProperties() { return Properties(SDL_GetGlobalProperties()); }
|
||||
/** @see SDL_GetNumberProperty
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetNumberProperty
|
||||
* @brief Gets a number property from a properties set.
|
||||
* @param name The name of the property.
|
||||
* @param default_value The default value to return if the property does not exist.
|
||||
* @return double The value of the property.
|
||||
*/
|
||||
double GetNumberProperty(const char* name, double default_value) const {
|
||||
return SDL_GetNumberProperty(*this, name, default_value);
|
||||
}
|
||||
/** @see SDL_GetPointerProperty
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetPointerProperty
|
||||
* @brief Gets a pointer property from a properties set.
|
||||
* @param name The name of the property.
|
||||
* @param default_value The default value to return if the property does not exist.
|
||||
* @return void* The value of the property.
|
||||
*/
|
||||
void* GetPointerProperty(const char* name, void* default_value) const {
|
||||
return SDL_GetPointerProperty(*this, name, default_value);
|
||||
}
|
||||
|
||||
/** @see SDL_GetPropertyType
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetPropertyType
|
||||
* @brief Gets the type of a property in a properties set.
|
||||
* @param name The name of the property.
|
||||
* @return SDL_PropertyType The type of the property.
|
||||
*/
|
||||
SDL_PropertyType GetPropertyType(const char* name) const { return SDL_GetPropertyType(*this, name); }
|
||||
/** @see SDL_GetStringProperty
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetStringProperty
|
||||
* @brief Gets a string property from a properties set.
|
||||
* @param name The name of the property.
|
||||
* @param default_value The default value to return if the property does not exist.
|
||||
* @return const char* The value of the property.
|
||||
*/
|
||||
const char* GetStringProperty(const char* name, const char* default_value) const {
|
||||
return SDL_GetStringProperty(*this, name, default_value);
|
||||
}
|
||||
/** @see SDL_HasProperty
|
||||
* https://wiki.libsdl.org/SDL3/SDL_HasProperty
|
||||
* @brief Checks if a property exists in a properties set.
|
||||
* @param name The name of the property.
|
||||
* @return bool True if the property exists, false otherwise.
|
||||
*/
|
||||
bool HasProperty(const char* name) const { return SDL_HasProperty(*this, name); }
|
||||
/** @see SDL_LockProperties
|
||||
* https://wiki.libsdl.org/SDL3/SDL_LockProperties
|
||||
* @brief Locks a properties set for writing.
|
||||
* @return bool True on success, false on failure.
|
||||
*/
|
||||
bool LockProperties() { return SDL_LockProperties(*this); }
|
||||
/** @see SDL_SetBooleanProperty
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetBooleanProperty
|
||||
* @brief Sets a boolean property in a properties set.
|
||||
* @param name The name of the property.
|
||||
* @param value The value to set.
|
||||
* @return bool True on success, false on failure.
|
||||
*/
|
||||
bool SetBooleanProperty(const char* name, bool value) { return SDL_SetBooleanProperty(*this, name, value); }
|
||||
// SDL_SetFloatProperty
|
||||
/** @see SDL_SetFloatProperty
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetFloatProperty
|
||||
* @brief Sets a float property in a properties set.
|
||||
* @param name The name of the property.
|
||||
* @param value The value to set.
|
||||
* @return bool True on success, false on failure.
|
||||
*/
|
||||
bool SetFloatProperty(const char* name, float value) { return SDL_SetFloatProperty(*this, name, value); }
|
||||
// SDL_SetNumberProperty
|
||||
/** @see SDL_SetNumberProperty
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetNumberProperty
|
||||
* @brief Sets a number property in a properties set.
|
||||
* @param name The name of the property.
|
||||
* @param value The value to set.
|
||||
* @return bool True on success, false on failure.
|
||||
*/
|
||||
bool SetNumberProperty(const char* name, double value) { return SDL_SetNumberProperty(*this, name, value); }
|
||||
// SDL_SetPointerProperty
|
||||
/** @see SDL_SetPointerProperty
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetPointerProperty
|
||||
* @brief Sets a pointer property in a properties set.
|
||||
* @param name The name of the property.
|
||||
* @param value The value to set.
|
||||
* @return bool True on success, false on failure.
|
||||
*/
|
||||
bool SetPointerProperty(const char* name, void* value) { return SDL_SetPointerProperty(*this, name, value); }
|
||||
// SDL_SetPointerPropertyWithCleanup
|
||||
/** @see SDL_SetPointerPropertyWithCleanup
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetPointerPropertyWithCleanup
|
||||
* @brief Sets a pointer property in a properties set with a cleanup callback.
|
||||
* @param name The name of the property.
|
||||
* @param value The value to set.
|
||||
* @param cleanup_callback An `SDL_CleanupPropertyCallback` function pointer that is called when the property is cleared or the properties set is destroyed.
|
||||
* @param userdata Void pointer that is passed to cleanup_callback.
|
||||
* @return bool True on success, false on failure.
|
||||
*/
|
||||
bool SetPointerPropertyWithCleanup(const char* name,
|
||||
void* value,
|
||||
SDL_CleanupPropertyCallback cleanup_callback,
|
||||
@@ -178,19 +54,8 @@ namespace hdk::sdl {
|
||||
return SDL_SetPointerPropertyWithCleanup(*this, name, value, cleanup_callback, userdata);
|
||||
}
|
||||
// SDL_SetStringProperty
|
||||
/** @see SDL_SetStringProperty
|
||||
* https://wiki.libsdl.org/SDL3/SDL_SetStringProperty
|
||||
* @brief Sets a string property in a properties set.
|
||||
* @param name The name of the property.
|
||||
* @param value The value to set.
|
||||
* @return bool True on success, false on failure.
|
||||
*/
|
||||
bool SetStringProperty(const char* name, const char* value) { return SDL_SetStringProperty(*this, name, value); }
|
||||
// SDL_UnlockProperties
|
||||
/** @see SDL_UnlockProperties
|
||||
* https://wiki.libsdl.org/SDL3/SDL_UnlockProperties
|
||||
* @brief Unlocks a properties set after writing.
|
||||
*/
|
||||
void UnlockProperties() { SDL_UnlockProperties(*this); }
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,862 @@
|
||||
#pragma once
|
||||
/// @file event.hpp
|
||||
/// For complete documentation, see src/event.cpp
|
||||
#include <SDL3/SDL_events.h>
|
||||
#include <SDL3/SDL_init.h>
|
||||
#include <hdk/grid/AbstractEventDispatch.hpp>
|
||||
#include <hdk/sdl/video/Window.hpp>
|
||||
#include <cstdio>
|
||||
#include <map>
|
||||
#include <string>
|
||||
|
||||
namespace hdk::sdl {
|
||||
class Event {
|
||||
public:
|
||||
static void AddWatch(SDL_EventFilter filter, void* userdata) { SDL_AddEventWatch(filter, userdata); }
|
||||
static bool EventEnabled(Uint32 type) { return SDL_EventEnabled(type); }
|
||||
static void FilterEvents(SDL_EventFilter filter, void* userdata) { SDL_FilterEvents(filter, userdata); }
|
||||
static void FlushEvent(Uint32 type) { SDL_FlushEvent(type); }
|
||||
static void FlushEvents(Uint32 min_type, Uint32 max_type) { SDL_FlushEvents(min_type, max_type); }
|
||||
static int GetDescription(const SDL_Event* event, char* buf, int buflen) {
|
||||
return SDL_GetEventDescription(event, buf, buflen);
|
||||
}
|
||||
static std::string GetDescription(const SDL_Event* event) {
|
||||
char buf[256];
|
||||
GetDescription(event, buf, sizeof(buf));
|
||||
return std::string(buf);
|
||||
}
|
||||
static bool GetFilter(SDL_EventFilter* filter, void** userdata) { return SDL_GetEventFilter(filter, userdata); }
|
||||
static Window GetWindowFromEvent(const SDL_Event* event) {
|
||||
return Window::get_or_view(SDL_GetWindowFromEvent(event));
|
||||
}
|
||||
static bool Has(Uint32 type) { return SDL_HasEvent(type); }
|
||||
static bool Has(Uint32 min_type, Uint32 max_type) { return SDL_HasEvents(min_type, max_type); }
|
||||
static int Peep(SDL_Event* events, int numevents, SDL_EventAction action, Uint32 min_type, Uint32 max_type) {
|
||||
return SDL_PeepEvents(events, numevents, action, min_type, max_type);
|
||||
}
|
||||
static bool Poll(SDL_Event* event) { return SDL_PollEvent(event); }
|
||||
static void Pump() { SDL_PumpEvents(); }
|
||||
static bool Push(SDL_Event* event) { return SDL_PushEvent(event); }
|
||||
template <int BUFLEN = 512> static std::string GetDescription(const SDL_Event* event) {
|
||||
char buf[BUFLEN];
|
||||
int actual_length = SDL_GetEventDescription(event, buf, sizeof(buf));
|
||||
if (actual_length > BUFLEN) {
|
||||
return std::string("BUFFER TOO SMALL");
|
||||
}
|
||||
return std::string(buf);
|
||||
}
|
||||
};
|
||||
|
||||
}
|
||||
|
||||
namespace hdk::sdl::evt {
|
||||
|
||||
class EventConduit : public hdk::grid::eps::Conduit<SDL_Event*> {
|
||||
public:
|
||||
using hdk::grid::eps::Conduit<SDL_Event*>::Conduit;
|
||||
};
|
||||
|
||||
template <typename ValueType, typename EventType = EventConduit,
|
||||
typename MapType = std::map<ValueType, EventType*>>
|
||||
class EventValueRouter : public EventConduit {
|
||||
public:
|
||||
// The type of the map of values to dispatch (for child classes to use)
|
||||
typedef MapType value_dispatch_map_t;
|
||||
// The map of values to dispatch to
|
||||
value_dispatch_map_t value_dispatch_map;
|
||||
// Constructor takes a map of values to dispatch to
|
||||
EventValueRouter(value_dispatch_map_t dispatch_map)
|
||||
: value_dispatch_map(dispatch_map) { }
|
||||
// The extractor function is a pure virtual function that child classes must implement to extract the value from
|
||||
// the event
|
||||
virtual ValueType extractor(SDL_Event* event) = 0;
|
||||
// The Trigger function overrides the base Event Trigger function to extract the value from the event and dispatch
|
||||
// to the appropriate callback based on that value, as well as triggering any callbacks in the base Event dispatch
|
||||
// list.
|
||||
virtual void Trigger(SDL_Event* event) override {
|
||||
if (!event)
|
||||
return;
|
||||
ValueType value = this->extractor(event);
|
||||
auto it = value_dispatch_map.find(value);
|
||||
if (it != value_dispatch_map.end() && it->second) {
|
||||
(*it->second)(event);
|
||||
} else {
|
||||
return;
|
||||
}
|
||||
EventConduit::Trigger(event);
|
||||
}
|
||||
// Allow direct access to the dispatch map for subscribing to specific values
|
||||
EventType& operator[](ValueType value) { return *value_dispatch_map[value]; }
|
||||
};
|
||||
|
||||
class EventTypeRouter
|
||||
: public EventValueRouter<SDL_EventType, EventConduit, std::map<SDL_EventType, EventConduit*>> {
|
||||
public:
|
||||
EventTypeRouter(value_dispatch_map_t dispatch_map)
|
||||
: EventValueRouter(std::move(dispatch_map)) { }
|
||||
virtual SDL_EventType extractor(SDL_Event* event) override { return (SDL_EventType)event->type; }
|
||||
};
|
||||
|
||||
class DisplayEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit Orientation, Added, Removed, Moved, DesktopModeChanged, CurrentModeChanged, ContentScaleChanged;
|
||||
// clang-format off
|
||||
DisplayEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_DISPLAY_ORIENTATION, &Orientation },
|
||||
{ SDL_EVENT_DISPLAY_ADDED, &Added },
|
||||
{ SDL_EVENT_DISPLAY_REMOVED, &Removed },
|
||||
{ SDL_EVENT_DISPLAY_MOVED, &Moved },
|
||||
{ SDL_EVENT_DISPLAY_DESKTOP_MODE_CHANGED, &DesktopModeChanged },
|
||||
{ SDL_EVENT_DISPLAY_CURRENT_MODE_CHANGED, &CurrentModeChanged },
|
||||
{ SDL_EVENT_DISPLAY_CONTENT_SCALE_CHANGED, &ContentScaleChanged }
|
||||
}) { }
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class KeyEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit Down, Up;
|
||||
// clang-format off
|
||||
KeyEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_KEY_DOWN, &Down },
|
||||
{ SDL_EVENT_KEY_UP, &Up }
|
||||
}) { };
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class KeysEvents : public EventValueRouter<SDL_Keycode, KeyEvents> {
|
||||
public:
|
||||
KeysEvents()
|
||||
: EventValueRouter({}) { }
|
||||
virtual SDL_Keycode extractor(SDL_Event* event) override { return event->key.key; }
|
||||
};
|
||||
|
||||
class JoystickAxisEvents : public EventValueRouter<Uint8> {
|
||||
public:
|
||||
JoystickAxisEvents()
|
||||
: EventValueRouter({}) { }
|
||||
virtual Uint8 extractor(SDL_Event* event) override { return event->jaxis.axis; }
|
||||
};
|
||||
|
||||
class JoystickBallEvents : public EventValueRouter<Uint8> {
|
||||
public:
|
||||
JoystickBallEvents()
|
||||
: EventValueRouter({}) { }
|
||||
virtual Uint8 extractor(SDL_Event* event) override { return event->jball.ball; }
|
||||
};
|
||||
|
||||
class JoystickHatEvents : public EventValueRouter<Uint8> {
|
||||
public:
|
||||
JoystickHatEvents()
|
||||
: EventValueRouter({}) { }
|
||||
virtual Uint8 extractor(SDL_Event* event) override { return event->jhat.hat; }
|
||||
};
|
||||
|
||||
class JoystickButtonEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit Down, Up;
|
||||
// clang-format off
|
||||
JoystickButtonEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_JOYSTICK_BUTTON_DOWN, &Down },
|
||||
{ SDL_EVENT_JOYSTICK_BUTTON_UP, &Up }
|
||||
}) { }
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class JoystickButtonsEvents : public EventValueRouter<Uint8, JoystickButtonEvents> {
|
||||
public:
|
||||
JoystickButtonsEvents()
|
||||
: EventValueRouter({}) { }
|
||||
virtual Uint8 extractor(SDL_Event* event) override { return event->jbutton.button; }
|
||||
};
|
||||
|
||||
class JoystickEvents : public EventTypeRouter {
|
||||
public:
|
||||
JoystickAxisEvents AxisMotion;
|
||||
JoystickBallEvents BallMotion;
|
||||
JoystickHatEvents HatMotion;
|
||||
JoystickButtonsEvents Button;
|
||||
EventConduit Added, Removed, BatteryUpdated, UpdateComplete;
|
||||
// clang-format off
|
||||
JoystickEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_JOYSTICK_AXIS_MOTION, &AxisMotion },
|
||||
{ SDL_EVENT_JOYSTICK_BALL_MOTION, &BallMotion },
|
||||
{ SDL_EVENT_JOYSTICK_HAT_MOTION, &HatMotion },
|
||||
{ SDL_EVENT_JOYSTICK_BUTTON_DOWN, &Button },
|
||||
{ SDL_EVENT_JOYSTICK_BUTTON_UP, &Button },
|
||||
{ SDL_EVENT_JOYSTICK_ADDED, &Added },
|
||||
{ SDL_EVENT_JOYSTICK_REMOVED, &Removed },
|
||||
{ SDL_EVENT_JOYSTICK_BATTERY_UPDATED, &BatteryUpdated },
|
||||
{ SDL_EVENT_JOYSTICK_UPDATE_COMPLETE, &UpdateComplete }
|
||||
}) { }
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class JoysticksEvents : public EventValueRouter<SDL_JoystickID, JoystickEvents> {
|
||||
public:
|
||||
JoysticksEvents()
|
||||
: EventValueRouter({}) { }
|
||||
virtual SDL_JoystickID extractor(SDL_Event* event) override {
|
||||
switch (event->type) {
|
||||
case SDL_EVENT_JOYSTICK_AXIS_MOTION:
|
||||
return event->jaxis.which;
|
||||
case SDL_EVENT_JOYSTICK_BALL_MOTION:
|
||||
return event->jball.which;
|
||||
case SDL_EVENT_JOYSTICK_HAT_MOTION:
|
||||
return event->jhat.which;
|
||||
case SDL_EVENT_JOYSTICK_BUTTON_DOWN:
|
||||
case SDL_EVENT_JOYSTICK_BUTTON_UP:
|
||||
return event->jbutton.which;
|
||||
case SDL_EVENT_JOYSTICK_ADDED:
|
||||
case SDL_EVENT_JOYSTICK_REMOVED:
|
||||
case SDL_EVENT_JOYSTICK_BATTERY_UPDATED:
|
||||
case SDL_EVENT_JOYSTICK_UPDATE_COMPLETE:
|
||||
return event->jdevice.which;
|
||||
default:
|
||||
return -1; // Invalid ID for unsupported event types
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
class GamepadAxisEvents : public EventValueRouter<SDL_GamepadAxis> {
|
||||
public:
|
||||
GamepadAxisEvents()
|
||||
: EventValueRouter({}) { }
|
||||
virtual SDL_GamepadAxis extractor(SDL_Event* event) override { return (SDL_GamepadAxis)event->gaxis.axis; }
|
||||
};
|
||||
|
||||
class GamepadButtonEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit Down, Up;
|
||||
// clang-format off
|
||||
GamepadButtonEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_GAMEPAD_BUTTON_DOWN, &Down },
|
||||
{ SDL_EVENT_GAMEPAD_BUTTON_UP, &Up }
|
||||
}) { }
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class GamepadButtonsEvents : public EventValueRouter<SDL_GamepadButton, GamepadButtonEvents> {
|
||||
public:
|
||||
GamepadButtonsEvents()
|
||||
: EventValueRouter({}) { }
|
||||
virtual SDL_GamepadButton extractor(SDL_Event* event) override {
|
||||
return (SDL_GamepadButton)event->gbutton.button;
|
||||
}
|
||||
};
|
||||
|
||||
class GamepadTouchpadEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit Down, Motion, Up;
|
||||
// clang-format off
|
||||
GamepadTouchpadEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_GAMEPAD_TOUCHPAD_DOWN, &Down },
|
||||
{ SDL_EVENT_GAMEPAD_TOUCHPAD_MOTION, &Motion },
|
||||
{ SDL_EVENT_GAMEPAD_TOUCHPAD_UP, &Up }
|
||||
}) { }
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class GamepadEvents : public EventTypeRouter {
|
||||
public:
|
||||
GamepadAxisEvents AxisMotion;
|
||||
GamepadButtonsEvents Button;
|
||||
EventConduit Added, Removed, Remapped;
|
||||
GamepadTouchpadEvents Touchpad;
|
||||
EventConduit SensorUpdate, UpdateComplete, SteamHandleUpdate;
|
||||
|
||||
// clang-format off
|
||||
GamepadEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_GAMEPAD_AXIS_MOTION, &AxisMotion },
|
||||
{ SDL_EVENT_GAMEPAD_BUTTON_DOWN, &Button },
|
||||
{ SDL_EVENT_GAMEPAD_BUTTON_UP, &Button },
|
||||
{ SDL_EVENT_GAMEPAD_ADDED, &Added },
|
||||
{ SDL_EVENT_GAMEPAD_REMOVED, &Removed },
|
||||
{ SDL_EVENT_GAMEPAD_REMAPPED, &Remapped },
|
||||
{ SDL_EVENT_GAMEPAD_TOUCHPAD_DOWN, &Touchpad },
|
||||
{ SDL_EVENT_GAMEPAD_TOUCHPAD_MOTION, &Touchpad },
|
||||
{ SDL_EVENT_GAMEPAD_TOUCHPAD_UP, &Touchpad },
|
||||
{ SDL_EVENT_GAMEPAD_SENSOR_UPDATE, &SensorUpdate },
|
||||
{ SDL_EVENT_GAMEPAD_UPDATE_COMPLETE, &UpdateComplete }
|
||||
}) {
|
||||
}
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class GamepadsEvents : public EventValueRouter<SDL_JoystickID, GamepadEvents> {
|
||||
public:
|
||||
GamepadsEvents()
|
||||
: EventValueRouter({}) { }
|
||||
virtual SDL_JoystickID extractor(SDL_Event* event) override {
|
||||
switch (event->type) {
|
||||
case SDL_EVENT_GAMEPAD_AXIS_MOTION:
|
||||
return event->gaxis.which;
|
||||
case SDL_EVENT_GAMEPAD_BUTTON_DOWN:
|
||||
case SDL_EVENT_GAMEPAD_BUTTON_UP:
|
||||
return event->gbutton.which;
|
||||
case SDL_EVENT_GAMEPAD_ADDED:
|
||||
case SDL_EVENT_GAMEPAD_REMOVED:
|
||||
case SDL_EVENT_GAMEPAD_REMAPPED:
|
||||
return event->gdevice.which;
|
||||
case SDL_EVENT_GAMEPAD_TOUCHPAD_DOWN:
|
||||
case SDL_EVENT_GAMEPAD_TOUCHPAD_MOTION:
|
||||
case SDL_EVENT_GAMEPAD_TOUCHPAD_UP:
|
||||
return event->gtouchpad.which;
|
||||
case SDL_EVENT_GAMEPAD_SENSOR_UPDATE:
|
||||
case SDL_EVENT_GAMEPAD_UPDATE_COMPLETE:
|
||||
case SDL_EVENT_GAMEPAD_STEAM_HANDLE_UPDATED:
|
||||
return event->gsensor.which;
|
||||
default:
|
||||
return -1; // Invalid ID for unsupported event types
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
class FingerEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit Down, Up, Motion, Canceled;
|
||||
// clang-format off
|
||||
FingerEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_FINGER_DOWN, &Down },
|
||||
{ SDL_EVENT_FINGER_UP, &Up },
|
||||
{ SDL_EVENT_FINGER_MOTION, &Motion } ,
|
||||
{ SDL_EVENT_FINGER_CANCELED, &Canceled }
|
||||
}) { }
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class DropEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit File, Text, Begin, Complete;
|
||||
// clang-format off
|
||||
DropEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_DROP_FILE, &File },
|
||||
{ SDL_EVENT_DROP_TEXT, &Text },
|
||||
{ SDL_EVENT_DROP_BEGIN, &Begin },
|
||||
{ SDL_EVENT_DROP_COMPLETE, &Complete }
|
||||
}) { }
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class AudioDeviceEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit Added, Removed, FormatChanged;
|
||||
// clang-format off
|
||||
AudioDeviceEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_AUDIO_DEVICE_ADDED, &Added },
|
||||
{ SDL_EVENT_AUDIO_DEVICE_REMOVED, &Removed },
|
||||
{ SDL_EVENT_AUDIO_DEVICE_FORMAT_CHANGED, &FormatChanged }
|
||||
}) {
|
||||
}
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class PenEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit ProximityIn, ProximityOut, Down, Up, Motion;
|
||||
// clang-format off
|
||||
PenEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_PEN_PROXIMITY_IN, &ProximityIn },
|
||||
{ SDL_EVENT_PEN_PROXIMITY_OUT, &ProximityOut },
|
||||
{ SDL_EVENT_PEN_DOWN, &Down },
|
||||
{ SDL_EVENT_PEN_UP, &Up },
|
||||
{ SDL_EVENT_PEN_MOTION, &Motion }
|
||||
}) { }
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class CameraDeviceEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit Added, Removed, Approved, Denied;
|
||||
// clang-format off
|
||||
CameraDeviceEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_CAMERA_DEVICE_ADDED, &Added },
|
||||
{ SDL_EVENT_CAMERA_DEVICE_REMOVED, &Removed },
|
||||
{ SDL_EVENT_CAMERA_DEVICE_APPROVED, &Approved } ,
|
||||
{ SDL_EVENT_CAMERA_DEVICE_DENIED, &Denied}
|
||||
}) {
|
||||
}
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class RenderEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit TargetsReset, DeviceReset, DeviceLost;
|
||||
// clang-format off
|
||||
RenderEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_RENDER_TARGETS_RESET, &TargetsReset },
|
||||
{ SDL_EVENT_RENDER_DEVICE_RESET, &DeviceReset },
|
||||
{ SDL_EVENT_RENDER_DEVICE_LOST, &DeviceLost }
|
||||
}) { }
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class KeyboardEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit Added, Removed;
|
||||
// clang-format off
|
||||
KeyboardEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_KEYBOARD_ADDED, &Added },
|
||||
{ SDL_EVENT_KEYBOARD_REMOVED, &Removed }
|
||||
}) { }
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class MouseButtonEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit Down, Up;
|
||||
// clang-format off
|
||||
MouseButtonEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_MOUSE_BUTTON_DOWN, &Down },
|
||||
{ SDL_EVENT_MOUSE_BUTTON_UP, &Up }
|
||||
}) { }
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class MouseButtonsEvents : public EventValueRouter<Uint8, MouseButtonEvents> {
|
||||
public:
|
||||
MouseButtonsEvents()
|
||||
: EventValueRouter({}) { }
|
||||
virtual Uint8 extractor(SDL_Event* event) override { return event->button.button; }
|
||||
};
|
||||
|
||||
class MouseEvents : public EventTypeRouter {
|
||||
public:
|
||||
MouseButtonsEvents Button;
|
||||
EventConduit Motion, Wheel, Added, Removed;
|
||||
// clang-format off
|
||||
MouseEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_MOUSE_MOTION, &Motion },
|
||||
{ SDL_EVENT_MOUSE_BUTTON_DOWN, &Button },
|
||||
{ SDL_EVENT_MOUSE_BUTTON_UP, &Button },
|
||||
{ SDL_EVENT_MOUSE_WHEEL, &Wheel },
|
||||
{ SDL_EVENT_MOUSE_ADDED, &Added },
|
||||
{ SDL_EVENT_MOUSE_REMOVED, &Removed }
|
||||
}) { }
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class MiceEvents : public EventValueRouter<SDL_MouseID, MouseEvents> {
|
||||
public:
|
||||
MiceEvents()
|
||||
: EventValueRouter({}) { }
|
||||
virtual SDL_MouseID extractor(SDL_Event* event) override {
|
||||
switch (event->type) {
|
||||
case SDL_EVENT_MOUSE_MOTION:
|
||||
return event->motion.which;
|
||||
case SDL_EVENT_MOUSE_BUTTON_DOWN:
|
||||
case SDL_EVENT_MOUSE_BUTTON_UP:
|
||||
return event->button.which;
|
||||
case SDL_EVENT_MOUSE_WHEEL:
|
||||
return event->wheel.which;
|
||||
case SDL_EVENT_MOUSE_ADDED:
|
||||
case SDL_EVENT_MOUSE_REMOVED:
|
||||
return event->mdevice.which;
|
||||
default:
|
||||
return -1; // Invalid ID for unsupported event types
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
class TextEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit Input, Editing, EditingCandidates;
|
||||
// clang-format off
|
||||
TextEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_TEXT_INPUT, &Input },
|
||||
{ SDL_EVENT_TEXT_EDITING, &Editing },
|
||||
{ SDL_EVENT_TEXT_EDITING_CANDIDATES, &EditingCandidates }
|
||||
}) { }
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class WindowEvents : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit Shown, Hidden, Exposed, Moved, Resized, PixelSizeChanged, MetalViewResized, Minimized, Maximized, Restored,
|
||||
MouseEnter, MouseLeave, FocusLost, CloseRequested, HitTest, ICCProfChange, DisplayChanged, DisplayScaleChanged,
|
||||
SafeAreaChanged, Occluded, EnterFullscreen, LeaveFullscreen, LeaveDesktop, TakeFocus, HitTestResult, Destroyed,
|
||||
HdrStateChanged;
|
||||
|
||||
// @todo possibly refactor to a specialized subclass,
|
||||
// these are not "WINDOW" events; but events that identify "WindowID",
|
||||
// and so we dispatch them to handlers for that window so that each window can have its own
|
||||
// unified set of handlers.
|
||||
FingerEvents Finger;
|
||||
PenEvents Pen;
|
||||
MiceEvents Mouse;
|
||||
KeysEvents Key;
|
||||
TextEvents Text;
|
||||
DropEvents Drop;
|
||||
RenderEvents Render;
|
||||
// clang-format off
|
||||
WindowEvents()
|
||||
: EventTypeRouter({
|
||||
{ SDL_EVENT_WINDOW_SHOWN, &Shown },
|
||||
{ SDL_EVENT_WINDOW_HIDDEN, &Hidden },
|
||||
{ SDL_EVENT_WINDOW_EXPOSED, &Exposed },
|
||||
{ SDL_EVENT_WINDOW_MOVED, &Moved },
|
||||
{ SDL_EVENT_WINDOW_RESIZED, &Resized },
|
||||
{ SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED, &PixelSizeChanged },
|
||||
{ SDL_EVENT_WINDOW_METAL_VIEW_RESIZED, &MetalViewResized },
|
||||
{ SDL_EVENT_WINDOW_MINIMIZED, &Minimized },
|
||||
{ SDL_EVENT_WINDOW_MAXIMIZED, &Maximized },
|
||||
{ SDL_EVENT_WINDOW_RESTORED, &Restored },
|
||||
{ SDL_EVENT_WINDOW_MOUSE_ENTER, &MouseEnter },
|
||||
{ SDL_EVENT_WINDOW_MOUSE_LEAVE, &MouseLeave },
|
||||
{ SDL_EVENT_WINDOW_FOCUS_LOST, &FocusLost },
|
||||
{ SDL_EVENT_WINDOW_CLOSE_REQUESTED, &CloseRequested },
|
||||
{ SDL_EVENT_WINDOW_HIT_TEST, &HitTest },
|
||||
{ SDL_EVENT_WINDOW_ICCPROF_CHANGED, &ICCProfChange },
|
||||
{ SDL_EVENT_WINDOW_DISPLAY_CHANGED, &DisplayChanged },
|
||||
{ SDL_EVENT_WINDOW_DISPLAY_SCALE_CHANGED, &DisplayScaleChanged },
|
||||
{ SDL_EVENT_WINDOW_SAFE_AREA_CHANGED, &SafeAreaChanged },
|
||||
{ SDL_EVENT_WINDOW_OCCLUDED, &Occluded },
|
||||
{ SDL_EVENT_WINDOW_ENTER_FULLSCREEN, &EnterFullscreen },
|
||||
{ SDL_EVENT_WINDOW_LEAVE_FULLSCREEN, &LeaveFullscreen },
|
||||
{ SDL_EVENT_WINDOW_DESTROYED, &Destroyed },
|
||||
{ SDL_EVENT_WINDOW_HDR_STATE_CHANGED, &HdrStateChanged },
|
||||
|
||||
{ SDL_EVENT_FINGER_DOWN, &Finger },
|
||||
{ SDL_EVENT_FINGER_UP, &Finger },
|
||||
{ SDL_EVENT_FINGER_MOTION, &Finger },
|
||||
{ SDL_EVENT_FINGER_CANCELED, &Finger },
|
||||
|
||||
{ SDL_EVENT_PEN_MOTION, &Pen },
|
||||
|
||||
{ SDL_EVENT_PEN_BUTTON_DOWN, &Pen },
|
||||
{ SDL_EVENT_PEN_BUTTON_UP, &Pen },
|
||||
|
||||
{ SDL_EVENT_PEN_AXIS, &Pen },
|
||||
|
||||
{ SDL_EVENT_MOUSE_WHEEL, &Mouse},
|
||||
|
||||
{ SDL_EVENT_MOUSE_MOTION, &Mouse},
|
||||
|
||||
{ SDL_EVENT_MOUSE_BUTTON_DOWN, &Mouse },
|
||||
{ SDL_EVENT_MOUSE_BUTTON_UP, &Mouse },
|
||||
|
||||
{ SDL_EVENT_KEY_DOWN, &Key },
|
||||
{ SDL_EVENT_KEY_UP, &Key },
|
||||
|
||||
{ SDL_EVENT_PEN_PROXIMITY_IN, &Pen },
|
||||
{ SDL_EVENT_PEN_PROXIMITY_OUT, &Pen },
|
||||
|
||||
{ SDL_EVENT_PEN_DOWN, &Pen },
|
||||
{ SDL_EVENT_PEN_UP, &Pen },
|
||||
|
||||
{ SDL_EVENT_TEXT_INPUT, &Text },
|
||||
|
||||
{ SDL_EVENT_TEXT_EDITING, &Text },
|
||||
|
||||
{ SDL_EVENT_TEXT_EDITING_CANDIDATES, &Text },
|
||||
|
||||
{ SDL_EVENT_RENDER_TARGETS_RESET, &Render },
|
||||
{ SDL_EVENT_RENDER_DEVICE_RESET, &Render },
|
||||
{ SDL_EVENT_RENDER_DEVICE_LOST, &Render },
|
||||
|
||||
{ SDL_EVENT_DROP_BEGIN, &Drop },
|
||||
{ SDL_EVENT_DROP_FILE, &Drop },
|
||||
{ SDL_EVENT_DROP_TEXT, &Drop },
|
||||
{ SDL_EVENT_DROP_COMPLETE, &Drop },
|
||||
{ SDL_EVENT_DROP_POSITION, &Drop }
|
||||
}) { }
|
||||
// clang-format on
|
||||
};
|
||||
|
||||
class WindowsEvents : public EventValueRouter<SDL_WindowID, WindowEvents> {
|
||||
public:
|
||||
std::map<SDL_WindowID, WindowEvents> windows;
|
||||
WindowsEvents()
|
||||
: EventValueRouter({}) { }
|
||||
WindowEvents& operator[](SDL_WindowID window_id) {
|
||||
WindowEvents& window = windows[window_id];
|
||||
value_dispatch_map[window_id] = &window;
|
||||
return window;
|
||||
}
|
||||
virtual SDL_WindowID extractor(SDL_Event* event) override {
|
||||
switch (event->type) {
|
||||
case SDL_EVENT_WINDOW_SHOWN:
|
||||
case SDL_EVENT_WINDOW_HIDDEN:
|
||||
case SDL_EVENT_WINDOW_EXPOSED:
|
||||
case SDL_EVENT_WINDOW_MOVED:
|
||||
case SDL_EVENT_WINDOW_RESIZED:
|
||||
case SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED:
|
||||
case SDL_EVENT_WINDOW_METAL_VIEW_RESIZED:
|
||||
case SDL_EVENT_WINDOW_MINIMIZED:
|
||||
case SDL_EVENT_WINDOW_MAXIMIZED:
|
||||
case SDL_EVENT_WINDOW_RESTORED:
|
||||
case SDL_EVENT_WINDOW_MOUSE_ENTER:
|
||||
case SDL_EVENT_WINDOW_MOUSE_LEAVE:
|
||||
case SDL_EVENT_WINDOW_FOCUS_GAINED:
|
||||
case SDL_EVENT_WINDOW_FOCUS_LOST:
|
||||
case SDL_EVENT_WINDOW_CLOSE_REQUESTED:
|
||||
case SDL_EVENT_WINDOW_HIT_TEST:
|
||||
case SDL_EVENT_WINDOW_ICCPROF_CHANGED:
|
||||
case SDL_EVENT_WINDOW_DISPLAY_CHANGED:
|
||||
case SDL_EVENT_WINDOW_DISPLAY_SCALE_CHANGED:
|
||||
case SDL_EVENT_WINDOW_SAFE_AREA_CHANGED:
|
||||
case SDL_EVENT_WINDOW_OCCLUDED:
|
||||
case SDL_EVENT_WINDOW_ENTER_FULLSCREEN:
|
||||
case SDL_EVENT_WINDOW_LEAVE_FULLSCREEN:
|
||||
case SDL_EVENT_WINDOW_DESTROYED:
|
||||
return event->window.windowID;
|
||||
|
||||
case SDL_EVENT_FINGER_DOWN:
|
||||
case SDL_EVENT_FINGER_UP:
|
||||
case SDL_EVENT_FINGER_MOTION:
|
||||
case SDL_EVENT_FINGER_CANCELED:
|
||||
return event->tfinger.windowID;
|
||||
|
||||
case SDL_EVENT_PEN_BUTTON_DOWN:
|
||||
case SDL_EVENT_PEN_BUTTON_UP:
|
||||
return event->pbutton.windowID;
|
||||
|
||||
case SDL_EVENT_PEN_AXIS:
|
||||
return event->paxis.windowID;
|
||||
|
||||
case SDL_EVENT_MOUSE_WHEEL:
|
||||
return event->wheel.windowID;
|
||||
case SDL_EVENT_MOUSE_MOTION:
|
||||
return event->motion.windowID;
|
||||
|
||||
case SDL_EVENT_MOUSE_BUTTON_DOWN:
|
||||
case SDL_EVENT_MOUSE_BUTTON_UP:
|
||||
return event->button.windowID;
|
||||
|
||||
case SDL_EVENT_KEY_DOWN:
|
||||
case SDL_EVENT_KEY_UP:
|
||||
return event->key.windowID;
|
||||
|
||||
case SDL_EVENT_PEN_PROXIMITY_IN:
|
||||
case SDL_EVENT_PEN_PROXIMITY_OUT:
|
||||
return event->pproximity.windowID;
|
||||
|
||||
case SDL_EVENT_PEN_DOWN:
|
||||
case SDL_EVENT_PEN_UP:
|
||||
return event->ptouch.windowID;
|
||||
|
||||
case SDL_EVENT_TEXT_INPUT:
|
||||
return event->text.windowID;
|
||||
|
||||
case SDL_EVENT_TEXT_EDITING:
|
||||
return event->edit.windowID;
|
||||
|
||||
case SDL_EVENT_TEXT_EDITING_CANDIDATES:
|
||||
return event->edit_candidates.windowID;
|
||||
|
||||
case SDL_EVENT_RENDER_TARGETS_RESET:
|
||||
case SDL_EVENT_RENDER_DEVICE_RESET:
|
||||
case SDL_EVENT_RENDER_DEVICE_LOST:
|
||||
return event->render.windowID;
|
||||
|
||||
case SDL_EVENT_DROP_BEGIN:
|
||||
case SDL_EVENT_DROP_FILE:
|
||||
case SDL_EVENT_DROP_TEXT:
|
||||
case SDL_EVENT_DROP_COMPLETE:
|
||||
case SDL_EVENT_DROP_POSITION:
|
||||
return event->drop.windowID;
|
||||
|
||||
default:
|
||||
if (event->type >= SDL_EVENT_USER && event->type <= SDL_EVENT_LAST) {
|
||||
// User events may have a windowID, but it's not guaranteed, so we check for it here
|
||||
return event->user.windowID;
|
||||
}
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
};
|
||||
|
||||
class AllTypes : public EventTypeRouter {
|
||||
public:
|
||||
EventConduit Quit, Terminating, LowMemory, WillEnterBackground, DidEnterBackground, WillEnterForeground, LocaleChanged,
|
||||
SystemThemeChanged;
|
||||
DisplayEvents Display;
|
||||
WindowsEvents Window;
|
||||
TextEvents Text;
|
||||
EventConduit KeymapChanged;
|
||||
KeysEvents Key;
|
||||
KeyboardEvents Keyboard;
|
||||
MiceEvents Mouse;
|
||||
JoysticksEvents Joystick;
|
||||
GamepadsEvents Gamepad;
|
||||
FingerEvents Finger;
|
||||
EventConduit ClipboardUpdate;
|
||||
DropEvents Drop;
|
||||
AudioDeviceEvents AudioDevice;
|
||||
EventConduit SensorUpdate;
|
||||
PenEvents Pen;
|
||||
CameraDeviceEvents CameraDevice;
|
||||
/* Render Events */
|
||||
RenderEvents Render;
|
||||
// clang-format off
|
||||
AllTypes()
|
||||
// https://wiki.libsdl.org/SDL3/SDL_EventType
|
||||
: EventTypeRouter({
|
||||
{SDL_EVENT_QUIT, &Quit },
|
||||
{SDL_EVENT_TERMINATING, &Terminating },
|
||||
{SDL_EVENT_LOW_MEMORY, &LowMemory },
|
||||
{SDL_EVENT_WILL_ENTER_BACKGROUND, &WillEnterBackground },
|
||||
{SDL_EVENT_DID_ENTER_BACKGROUND, &DidEnterBackground },
|
||||
{SDL_EVENT_WILL_ENTER_FOREGROUND, &WillEnterForeground },
|
||||
{SDL_EVENT_LOCALE_CHANGED, &LocaleChanged },
|
||||
{SDL_EVENT_SYSTEM_THEME_CHANGED, &SystemThemeChanged },
|
||||
{SDL_EVENT_DISPLAY_ORIENTATION, &Display },
|
||||
{SDL_EVENT_DISPLAY_ADDED, &Display },
|
||||
{SDL_EVENT_DISPLAY_REMOVED, &Display },
|
||||
{SDL_EVENT_DISPLAY_MOVED, &Display },
|
||||
{SDL_EVENT_DISPLAY_DESKTOP_MODE_CHANGED, &Display },
|
||||
{SDL_EVENT_DISPLAY_CURRENT_MODE_CHANGED, &Display },
|
||||
{SDL_EVENT_DISPLAY_CONTENT_SCALE_CHANGED, &Display },
|
||||
{SDL_EVENT_WINDOW_SHOWN, &Window },
|
||||
{SDL_EVENT_WINDOW_HIDDEN, &Window },
|
||||
{SDL_EVENT_WINDOW_EXPOSED, &Window },
|
||||
{SDL_EVENT_WINDOW_MOVED, &Window },
|
||||
{SDL_EVENT_WINDOW_RESIZED, &Window },
|
||||
{SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED, &Window },
|
||||
{SDL_EVENT_WINDOW_METAL_VIEW_RESIZED, &Window },
|
||||
{SDL_EVENT_WINDOW_MINIMIZED, &Window },
|
||||
{SDL_EVENT_WINDOW_MAXIMIZED, &Window },
|
||||
{SDL_EVENT_WINDOW_RESTORED, &Window },
|
||||
{SDL_EVENT_WINDOW_MOUSE_ENTER, &Window },
|
||||
{SDL_EVENT_WINDOW_MOUSE_LEAVE, &Window },
|
||||
{SDL_EVENT_WINDOW_FOCUS_LOST, &Window },
|
||||
{SDL_EVENT_WINDOW_CLOSE_REQUESTED, &Window },
|
||||
{SDL_EVENT_WINDOW_HIT_TEST, &Window },
|
||||
{SDL_EVENT_WINDOW_ICCPROF_CHANGED, &Window },
|
||||
{SDL_EVENT_WINDOW_DISPLAY_CHANGED, &Window },
|
||||
{SDL_EVENT_WINDOW_DISPLAY_SCALE_CHANGED, &Window },
|
||||
{SDL_EVENT_WINDOW_SAFE_AREA_CHANGED, &Window },
|
||||
{SDL_EVENT_WINDOW_OCCLUDED, &Window },
|
||||
{SDL_EVENT_WINDOW_ENTER_FULLSCREEN, &Window },
|
||||
{SDL_EVENT_WINDOW_LEAVE_FULLSCREEN, &Window },
|
||||
{SDL_EVENT_WINDOW_DESTROYED, &Window },
|
||||
{SDL_EVENT_WINDOW_HDR_STATE_CHANGED, &Window },
|
||||
{SDL_EVENT_KEY_DOWN, &Key },
|
||||
{SDL_EVENT_KEY_UP, &Key },
|
||||
{SDL_EVENT_TEXT_EDITING, &Text },
|
||||
{SDL_EVENT_TEXT_INPUT, &Text },
|
||||
{SDL_EVENT_TEXT_EDITING_CANDIDATES, &Text },
|
||||
{SDL_EVENT_KEYMAP_CHANGED, &KeymapChanged },
|
||||
{SDL_EVENT_KEYBOARD_ADDED, &Keyboard },
|
||||
{SDL_EVENT_KEYBOARD_REMOVED, &Keyboard },
|
||||
{SDL_EVENT_MOUSE_MOTION, &Mouse },
|
||||
{SDL_EVENT_MOUSE_BUTTON_DOWN, &Mouse },
|
||||
{SDL_EVENT_MOUSE_BUTTON_UP, &Mouse },
|
||||
{SDL_EVENT_MOUSE_WHEEL, &Mouse },
|
||||
{SDL_EVENT_MOUSE_ADDED, &Mouse},
|
||||
{SDL_EVENT_MOUSE_REMOVED, &Mouse},
|
||||
{SDL_EVENT_JOYSTICK_AXIS_MOTION, &Joystick},
|
||||
{SDL_EVENT_JOYSTICK_BALL_MOTION, &Joystick},
|
||||
{SDL_EVENT_JOYSTICK_HAT_MOTION, &Joystick},
|
||||
{SDL_EVENT_JOYSTICK_BUTTON_DOWN, &Joystick},
|
||||
{SDL_EVENT_JOYSTICK_BUTTON_UP, &Joystick},
|
||||
{SDL_EVENT_JOYSTICK_ADDED, &Joystick},
|
||||
{SDL_EVENT_JOYSTICK_REMOVED, &Joystick},
|
||||
{SDL_EVENT_JOYSTICK_BATTERY_UPDATED, &Joystick},
|
||||
{SDL_EVENT_JOYSTICK_UPDATE_COMPLETE, &Joystick},
|
||||
{SDL_EVENT_GAMEPAD_AXIS_MOTION, &Gamepad},
|
||||
{SDL_EVENT_GAMEPAD_BUTTON_DOWN, &Gamepad},
|
||||
{SDL_EVENT_GAMEPAD_BUTTON_UP, &Gamepad},
|
||||
{SDL_EVENT_GAMEPAD_ADDED, &Gamepad},
|
||||
{SDL_EVENT_GAMEPAD_REMOVED, &Gamepad},
|
||||
{SDL_EVENT_GAMEPAD_REMAPPED, &Gamepad},
|
||||
{SDL_EVENT_GAMEPAD_TOUCHPAD_DOWN, &Gamepad},
|
||||
{SDL_EVENT_GAMEPAD_TOUCHPAD_MOTION, &Gamepad},
|
||||
{SDL_EVENT_GAMEPAD_TOUCHPAD_UP, &Gamepad},
|
||||
{SDL_EVENT_GAMEPAD_SENSOR_UPDATE, &Gamepad},
|
||||
{SDL_EVENT_GAMEPAD_UPDATE_COMPLETE, &Gamepad},
|
||||
{SDL_EVENT_GAMEPAD_STEAM_HANDLE_UPDATED, &Gamepad},
|
||||
{SDL_EVENT_FINGER_DOWN, &Finger},
|
||||
{SDL_EVENT_FINGER_UP, &Finger},
|
||||
{SDL_EVENT_FINGER_MOTION, &Finger},
|
||||
{SDL_EVENT_FINGER_CANCELED, &Finger},
|
||||
{SDL_EVENT_CLIPBOARD_UPDATE, &ClipboardUpdate},
|
||||
{SDL_EVENT_DROP_FILE, &Drop},
|
||||
{SDL_EVENT_DROP_TEXT, &Drop},
|
||||
{SDL_EVENT_DROP_BEGIN, &Drop},
|
||||
{SDL_EVENT_DROP_COMPLETE, &Drop},
|
||||
{SDL_EVENT_DROP_POSITION, &Drop},
|
||||
{SDL_EVENT_AUDIO_DEVICE_ADDED, &AudioDevice},
|
||||
{SDL_EVENT_AUDIO_DEVICE_REMOVED, &AudioDevice},
|
||||
{SDL_EVENT_AUDIO_DEVICE_FORMAT_CHANGED, &AudioDevice},
|
||||
{SDL_EVENT_SENSOR_UPDATE, &SensorUpdate},
|
||||
{SDL_EVENT_PEN_PROXIMITY_IN, &Pen},
|
||||
{SDL_EVENT_PEN_PROXIMITY_OUT, &Pen},
|
||||
{SDL_EVENT_PEN_DOWN, &Pen },
|
||||
{SDL_EVENT_PEN_UP, &Pen},
|
||||
{SDL_EVENT_PEN_BUTTON_DOWN, &Pen},
|
||||
{SDL_EVENT_PEN_BUTTON_UP, &Pen},
|
||||
{SDL_EVENT_PEN_MOTION, &Pen},
|
||||
{SDL_EVENT_PEN_AXIS, &Pen},
|
||||
{SDL_EVENT_CAMERA_DEVICE_ADDED, &CameraDevice},
|
||||
{SDL_EVENT_CAMERA_DEVICE_REMOVED, &CameraDevice},
|
||||
{SDL_EVENT_CAMERA_DEVICE_APPROVED, &CameraDevice },
|
||||
{SDL_EVENT_CAMERA_DEVICE_DENIED, &CameraDevice},
|
||||
{SDL_EVENT_RENDER_TARGETS_RESET , &Render },
|
||||
{SDL_EVENT_RENDER_DEVICE_RESET, &Render},
|
||||
{SDL_EVENT_RENDER_DEVICE_LOST, &Render}
|
||||
}) { };
|
||||
// clang-format on
|
||||
|
||||
// In addition to dispatching things to their normal handler we are also going to send all events that have a
|
||||
// WindowID to the CompleteWindowsEvents handler, so that users can listen for all events related to a specific
|
||||
// window in one place if they want to.
|
||||
virtual void Trigger(SDL_Event* event) override {
|
||||
switch (event->type) {
|
||||
// SDL_EVENT_WINDOW_* is already forwarded to Window event handlers
|
||||
// But these following events contain a WindowID, and so we want to forward them too there.
|
||||
// THat way people can subscribe to things like All mouse events for Window 'x'.
|
||||
case SDL_EVENT_FINGER_DOWN:
|
||||
case SDL_EVENT_FINGER_UP:
|
||||
case SDL_EVENT_FINGER_MOTION:
|
||||
case SDL_EVENT_FINGER_CANCELED:
|
||||
case SDL_EVENT_PEN_MOTION:
|
||||
case SDL_EVENT_PEN_BUTTON_DOWN:
|
||||
case SDL_EVENT_PEN_BUTTON_UP:
|
||||
case SDL_EVENT_PEN_AXIS:
|
||||
case SDL_EVENT_MOUSE_WHEEL:
|
||||
case SDL_EVENT_MOUSE_MOTION:
|
||||
case SDL_EVENT_MOUSE_BUTTON_DOWN:
|
||||
case SDL_EVENT_MOUSE_BUTTON_UP:
|
||||
case SDL_EVENT_KEY_DOWN:
|
||||
case SDL_EVENT_KEY_UP:
|
||||
case SDL_EVENT_PEN_PROXIMITY_IN:
|
||||
case SDL_EVENT_PEN_PROXIMITY_OUT:
|
||||
case SDL_EVENT_PEN_DOWN:
|
||||
case SDL_EVENT_PEN_UP:
|
||||
case SDL_EVENT_TEXT_INPUT:
|
||||
case SDL_EVENT_TEXT_EDITING:
|
||||
case SDL_EVENT_TEXT_EDITING_CANDIDATES:
|
||||
case SDL_EVENT_RENDER_TARGETS_RESET:
|
||||
case SDL_EVENT_RENDER_DEVICE_RESET:
|
||||
case SDL_EVENT_RENDER_DEVICE_LOST:
|
||||
case SDL_EVENT_DROP_BEGIN:
|
||||
case SDL_EVENT_DROP_FILE:
|
||||
case SDL_EVENT_DROP_TEXT:
|
||||
case SDL_EVENT_DROP_COMPLETE:
|
||||
case SDL_EVENT_DROP_POSITION:
|
||||
Window(event);
|
||||
// default:
|
||||
// do nothing additional for the others
|
||||
}
|
||||
EventTypeRouter::Trigger(event);
|
||||
}
|
||||
};
|
||||
} // namespace hdk::sdl::evt
|
||||
@@ -0,0 +1,36 @@
|
||||
#pragma once
|
||||
#define SDL_MAIN_USE_CALLBACKS 1
|
||||
#include <SDL3/SDL_main.h>
|
||||
#include <hdk/sdl/Application.hpp>
|
||||
|
||||
/// @macro HDK_SDL_MAIN_CLASS(klass)
|
||||
/// @brief Define the SDL main entry point using a class implementing hdk::sdl::ApplicationInterface.
|
||||
/// @param klass Class name of the application implementation. Must implement hdk::sdl::ApplicationInterface with Init,
|
||||
/// Event, Iterate, and Quit methods.
|
||||
/// @details This macro generates the SDL main entry point functions (SDL_AppInit, SDL_AppEvent, SDL_AppIterate,
|
||||
/// SDL_AppQuit) that create an instance of the specified class and delegate to its methods. This allows users to write
|
||||
/// their application logic in a clean class structure while still integrating with SDL's application lifecycle. The
|
||||
/// generated main functions handle the boilerplate of managing the application instance and connecting it to SDL's
|
||||
/// event loop and lifecycle callbacks.
|
||||
|
||||
#define HDK_SDL_MAIN_CLASS(klass) \
|
||||
SDL_AppResult SDL_AppInit(void** appstate, int argc, char* argv[]) { \
|
||||
klass* app = new klass(); \
|
||||
*appstate = app; \
|
||||
return app->Init(argc, argv); \
|
||||
} \
|
||||
SDL_AppResult SDL_AppEvent(void* appstate, SDL_Event* event) { \
|
||||
klass* app = static_cast<klass*>(appstate); \
|
||||
return app->Event(event); \
|
||||
} \
|
||||
SDL_AppResult SDL_AppIterate(void* appstate) { \
|
||||
klass* app = static_cast<klass*>(appstate); \
|
||||
return app->Iterate(); \
|
||||
} \
|
||||
void SDL_AppQuit(void* appstate, SDL_AppResult result) { \
|
||||
klass* app = static_cast<klass*>(appstate); \
|
||||
app->Quit(result); \
|
||||
delete app; \
|
||||
}
|
||||
|
||||
// end of file
|
||||
@@ -1,14 +1,11 @@
|
||||
#pragma once
|
||||
/** @file pixels.hpp
|
||||
* @brief glue together various pixel related wrappers that have circular dependencies
|
||||
*/
|
||||
/// @file pixels.hpp
|
||||
/// For complete documentation, see src/pixels.cpp
|
||||
#include "pixels/PixelFormat.hpp"
|
||||
#include "pixels/PixelFormatDetails.hpp"
|
||||
#include "pixels/Palette.hpp"
|
||||
|
||||
/** Pixels are a complex subject. */
|
||||
namespace hdk::sdl {
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetPixelFormatDetails */
|
||||
PixelFormatDetails PixelFormat::GetDetails() const { return PixelFormatDetails::Get(*this); }
|
||||
|
||||
|
||||
}
|
||||
@@ -1,37 +1,18 @@
|
||||
#pragma once
|
||||
/** @file Palette.hpp
|
||||
* @brief HDK sdl video header only wrapper for SDL_Palette struct & related functions
|
||||
*/
|
||||
/// @file Palette.hpp
|
||||
/// For complete documentation, see src/pixels/Palette.cpp
|
||||
#include <SDL3/SDL_pixels.h>
|
||||
#include <hdk/grid/SharedPtrWrapper.hpp>
|
||||
namespace hdk::sdl {
|
||||
/**
|
||||
* @brief
|
||||
* @note
|
||||
*/
|
||||
class Palette : public hdk::grid::SharedPtrWrapper<SDL_Palette> {
|
||||
public:
|
||||
/** Inherit constructors from SharedPtrWrapper */
|
||||
friend class Texture;
|
||||
friend class Surface;
|
||||
using hdk::grid::SharedPtrWrapper<SDL_Palette>::SharedPtrWrapper;
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_CreatePalette
|
||||
* @brief Create a palette with a specified number of colors.
|
||||
* @param ncolors The number of colors in the palette.
|
||||
* @return Palette The created palette. If the creation fails, returns an invalid palette.
|
||||
*/
|
||||
static Palette Create(int ncolors) {
|
||||
return Palette(get_or_cache(SDL_CreatePalette(ncolors), SDL_DestroyPalette));
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_DestroyPalette
|
||||
* @brief Destroy a palette and free its associated memory.
|
||||
*/
|
||||
void Destroy() const { SDL_DestroyPalette(*this); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetPaletteColors
|
||||
* @brief Set a range of colors in a palette.
|
||||
* @param colors An array of SDL_Color structures representing the colors to set in the palette.
|
||||
* @param firstcolor The index of the first color to set in the palette.
|
||||
* @param ncolors The number of colors to set in the palette.
|
||||
* @return bool True on success, false on failure.
|
||||
*/
|
||||
bool SetColors(const SDL_Color* colors, int firstcolor, int ncolors) const {
|
||||
return SDL_SetPaletteColors(*this, colors, firstcolor, ncolors);
|
||||
}
|
||||
|
||||
@@ -1,52 +1,23 @@
|
||||
#pragma once
|
||||
/** @file PixelFormat.hpp
|
||||
* @brief HDK sdl video header only wrapper for SDL_PixelFormat enum & related functions
|
||||
*/
|
||||
/// @file PixelFormat.hpp
|
||||
/// For complete documentation, see src/pixels/PixelFormat.cpp
|
||||
#include <SDL3/SDL_pixels.h>
|
||||
#include <hdk/grid/PrimitiveWrapper.hpp>
|
||||
/** PixelFormat makes working with SDL_PixelFormat easier. */
|
||||
namespace hdk::sdl {
|
||||
/// Forward declare to avoid circular dependency with PixelFormatDetails
|
||||
class PixelFormatDetails;
|
||||
/**
|
||||
* @brief
|
||||
*
|
||||
*/
|
||||
class PixelFormat : public hdk::grid::PrimitiveWrapper<SDL_PixelFormat> {
|
||||
public:
|
||||
/** Inherit constructors from PrimitiveWrapper */
|
||||
using hdk::grid::PrimitiveWrapper<SDL_PixelFormat>::PrimitiveWrapper;
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetMasksForPixelFormat
|
||||
* @brief Get the pixel format masks for a given pixel format.
|
||||
* @param bpp Pointer to int to be filled in with the number of bytes per pixel.
|
||||
* @param Rmask Pointer to Uint32 to be filled in with the red mask for the pixel format.
|
||||
* @param Gmask Pointer to Uint32 to be filled in with the green mask for the pixel format.
|
||||
* @param Bmask Pointer to Uint32 to be filled in with the blue mask for the pixel format.
|
||||
* @param Amask Pointer to Uint32 to be filled in with the alpha mask for the pixel format.
|
||||
* @return bool True on success
|
||||
*/
|
||||
bool GetMasks(int* bpp, Uint32* Rmask, Uint32* Gmask, Uint32* Bmask, Uint32* Amask) const {
|
||||
return SDL_GetMasksForPixelFormat(*this, bpp, Rmask, Gmask, Bmask, Amask);
|
||||
}
|
||||
// Implemented in `../pixels.hpp` to avoid circular dependency
|
||||
PixelFormatDetails GetDetails() const;
|
||||
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetPixelFormatForMasks
|
||||
* @brief Get the pixel format for a given set of pixel format masks.
|
||||
* @param bpp The number of bytes per pixel for the pixel format.
|
||||
* @param Rmask The red mask for the pixel format.
|
||||
* @param Gmask The green mask for the pixel format.
|
||||
* @param Bmask The blue mask for the pixel format.
|
||||
* @param Amask The alpha mask for the pixel format.
|
||||
* @return The pixel format corresponding to the given masks, or ::SDL_PIXELFORMAT_UNKNOWN
|
||||
*/
|
||||
static SDL_PixelFormat GetForMasks(int bpp, Uint32 Rmask, Uint32 Gmask, Uint32 Bmask, Uint32 Amask) {
|
||||
return SDL_GetPixelFormatForMasks(bpp, Rmask, Gmask, Bmask, Amask);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetPixelFormatName
|
||||
* @brief Get the name of a pixel format.
|
||||
* @return const char* The name of the pixel format, or "Unknown" if the pixel format is not recognized.
|
||||
*/
|
||||
const char* GetName() const { return SDL_GetPixelFormatName(*this); }
|
||||
|
||||
};
|
||||
|
||||
@@ -1,70 +1,24 @@
|
||||
#pragma once
|
||||
/** @file Palette.hpp
|
||||
* @brief HDK sdl video header only wrapper pointers to const SDL_PixelFormatDetails & related functions
|
||||
* @note Does note use smartpointers because these are SDL owned constant structs.
|
||||
*/
|
||||
/// @file PixelFormatDetails.hpp
|
||||
/// For complete documentation, see src/pixels/PixelFormatDetails.cpp
|
||||
#include <SDL3/SDL_pixels.h>
|
||||
#include <hdk/grid/PrimitiveWrapper.hpp>
|
||||
/** PixelFormatDetails makes getting the details of a pixel format easier. */
|
||||
namespace hdk::sdl {
|
||||
/**
|
||||
* @brief
|
||||
*
|
||||
*/
|
||||
class PixelFormatDetails : public hdk::grid::PrimitiveWrapper<const SDL_PixelFormatDetails*> {
|
||||
public:
|
||||
/** Inherit constructors from PrimitiveWrapper */
|
||||
using hdk::grid::PrimitiveWrapper<const SDL_PixelFormatDetails*>::PrimitiveWrapper;
|
||||
/*** @see https://wiki.libsdl.org/SDL3/SDL_GetPixelFormatDetails
|
||||
* @returns an PixelFormatDetails instance
|
||||
*/
|
||||
static PixelFormatDetails Get(SDL_PixelFormat format) {
|
||||
return PixelFormatDetails(SDL_GetPixelFormatDetails(format));
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetRGB
|
||||
* @brief Get the RGB values for a pixel value
|
||||
* @param pixel The pixel value to query
|
||||
* @param palette for indexed formats the palette to use, or NULL for non-indexed formats
|
||||
* @param r pointer to Uint8 to store the red component
|
||||
* @param g pointer to Uint8 to store the green component
|
||||
* @param b pointer to Uint8 to store the blue component
|
||||
* @param a pointer to Uint8 to store the alpha component
|
||||
*/
|
||||
void GetRGB(Uint32 pixel, SDL_Palette* palette, Uint8* r, Uint8* g, Uint8* b, Uint8* a) const {
|
||||
SDL_GetRGB(pixel, *this, palette, r, g, b, a);
|
||||
void GetRGB(Uint32 pixel, SDL_Palette* palette, Uint8* r, Uint8* g, Uint8* b) const {
|
||||
SDL_GetRGB(pixel, *this, palette, r, g, b);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetRGBA
|
||||
* @brief Get the RGBA values for a pixel value
|
||||
* @param pixel The pixel value to query
|
||||
* @param palette for indexed formats the palette to use, or NULL for non-indexed formats
|
||||
* @param r pointer to Uint8 to store the red component
|
||||
* @param g pointer to Uint8 to store the green component
|
||||
* @param b pointer to Uint8 to store the blue component
|
||||
* @param a pointer to Uint8 to store the alpha component
|
||||
*/
|
||||
void GetRGBA(Uint32 pixel, SDL_Palette* palette, Uint8* r, Uint8* g, Uint8* b, Uint8* a) const {
|
||||
SDL_GetRGBA(pixel, *this, palette, r, g, b, a);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_MapRGB
|
||||
* @brief Map RGB values to a pixel value for the pixel format
|
||||
* @param palette for indexed formats the palette to use, or NULL for non-indexed formats
|
||||
* @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 pixel value corresponding to the given RGB values for the pixel format
|
||||
*/
|
||||
Uint32 MapRGB(SDL_Palette* palette, Uint8 r, Uint8 g, Uint8 b) const {
|
||||
return SDL_MapRGB(*this, palette, r, g, b);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_MapRGBA
|
||||
* @brief Map RGBA values to a pixel value for the pixel format
|
||||
* @param palette for indexed formats the palette to use, or NULL for non-indexed formats
|
||||
* @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 pixel value corresponding to the given RGBA values for the pixel format
|
||||
*/
|
||||
Uint32 MapRGBA(SDL_Palette* palette, Uint8 r, Uint8 g, Uint8 b, Uint8 a) const {
|
||||
return SDL_MapRGBA(*this, palette, r, g, b, a);
|
||||
}
|
||||
|
||||
@@ -1,44 +1,26 @@
|
||||
#pragma once
|
||||
/**
|
||||
* @file render.hpp
|
||||
* @brief HDK sdl Renderer subsystem. Glues together Texture & Renderer which have circular dependencies
|
||||
*/
|
||||
/// @file render.hpp
|
||||
/// For complete documentation, see src/render.cpp
|
||||
#include <hdk/sdl/render/Renderer.hpp>
|
||||
#include <hdk/sdl/render/Texture.hpp>
|
||||
|
||||
namespace hdk::sdl {
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetRendererFromTexture
|
||||
* @return Renderer The renderer associated with the texture
|
||||
*/
|
||||
inline Renderer Texture::GetRenderer() const {
|
||||
/** we may not have created the renderer we get back, if not we will not own it. */
|
||||
return Renderer(Renderer::get_or_view(SDL_GetRendererFromTexture(*this)));
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_CreateTexture
|
||||
* @brief Create a texture for a rendering context.
|
||||
* @param format The pixel format of the texture
|
||||
* @param access The access pattern for the texture
|
||||
* @param w The width of the texture in pixels
|
||||
* @param h The height of the texture in pixels
|
||||
* @return Texture The created texture. If the creation fails, returns an invalid texture.
|
||||
*/
|
||||
inline Texture Renderer::CreateTexture(SDL_PixelFormat format, SDL_TextureAccess access, int w, int h) const {
|
||||
return Texture(Texture::get_or_cache(SDL_CreateTexture(*this, format, access, w, h), SDL_DestroyTexture));
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_CreateTextureFromSurface
|
||||
* @brief Create a texture from an existing surface.
|
||||
* @param surface The surface to create the texture from.
|
||||
* @return Texture The created texture. If the creation fails, returns an invalid texture.
|
||||
*/
|
||||
inline Texture Renderer::CreateTextureFromSurface(SDL_Surface* surface) const {
|
||||
return Texture(Texture::get_or_cache(SDL_CreateTextureFromSurface(*this, surface), SDL_DestroyTexture));
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_CreateTextureWithProperties
|
||||
* @brief Create a texture for a rendering context with specific properties.
|
||||
* @param properties The properties to create the texture with.
|
||||
* @return Texture The created texture. If the creation fails, returns an invalid texture.
|
||||
*/
|
||||
inline Texture Renderer::CreateTextureWithProperties(SDL_PropertiesID properties) const {
|
||||
return Texture(Texture::get_or_cache(SDL_CreateTextureWithProperties(*this, properties), SDL_DestroyTexture));
|
||||
}
|
||||
|
||||
inline Texture Renderer::GetRenderTarget() const {
|
||||
/** we may not have created the texture we get back, if not we will not own it. */
|
||||
return Texture(Texture::get_or_view(SDL_GetRenderTarget(*this)));
|
||||
}
|
||||
}
|
||||
@@ -1,38 +1,27 @@
|
||||
#pragma once
|
||||
/** @file Renderer.hpp
|
||||
* @brief HDK sdl video header only wrapper for SDL_Renderer struct & related functions
|
||||
*/
|
||||
/// @file Renderer.hpp
|
||||
/// Header-only wrapper for SDL_Renderer struct & related functions.
|
||||
/// For complete documentation, see src/render/Renderer.cpp
|
||||
///
|
||||
#include <SDL3/SDL.h>
|
||||
#include <hdk/grid/SharedPtrWrapper.hpp>
|
||||
#include <hdk/sdl/Properties.hpp>
|
||||
/** Renderers are used to render 2D graphics in SDL */
|
||||
#include <hdk/sdl/video/Surface.hpp>
|
||||
|
||||
namespace hdk::sdl {
|
||||
class Window;
|
||||
class Texture;
|
||||
/**
|
||||
* @brief Wraps the SDL_Renderer struct and related functions in a C++ class that uses shared_ptr for lifetime management.
|
||||
*
|
||||
*
|
||||
*/
|
||||
class Renderer : public hdk::grid::SharedPtrWrapper<SDL_Renderer> {
|
||||
public:
|
||||
friend class Window;
|
||||
friend class Texture;
|
||||
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_Renderer>::SharedPtrWrapper;
|
||||
/// @todo https://wiki.libsdl.org/SDL3/SDL_AddVulkanRenderSemaphores
|
||||
/// @todo https://wiki.libsdl.org/SDL3/SDL_ConvertEventToRenderCoordinates
|
||||
/// @todo https://wiki.libsdl.org/SDL3/SDL_CreateGPURenderer
|
||||
/// @todo https://wiki.libsdl.org/SDL3/SDL_CreateGPURenderState
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_CreateRenderer
|
||||
* @brief Create a renderer for a window.
|
||||
* @param window The window to create the renderer for. If the window is invalid, this function will return an
|
||||
* invalid renderer.
|
||||
* @param driverName The name of the rendering driver to initialize. If NULL, the first is used.
|
||||
* @return Renderer The created renderer. If the creation fails, returns an invalid renderer.
|
||||
*/
|
||||
/// @todo SDL_AddVulkanRenderSemaphores
|
||||
/// @todo SDL_ConvertEventToRenderCoordinates
|
||||
/// @todo SDL_CreateGPURenderer
|
||||
/// @todo SDL_CreateGPURenderState
|
||||
static Renderer Create(SDL_Window* window, const char* driverName) {
|
||||
return Renderer(get_or_cache(SDL_CreateRenderer(window, driverName), SDL_DestroyRenderer));
|
||||
}
|
||||
@@ -41,62 +30,27 @@ namespace hdk::sdl {
|
||||
static Renderer CreateSoftware(SDL_Surface* surface) {
|
||||
return Renderer(get_or_cache(SDL_CreateSoftwareRenderer(surface), SDL_DestroyRenderer));
|
||||
}
|
||||
/// @todo https://wiki.libsdl.org/SDL3/SDL_CreateWindowAndRenderer
|
||||
/// @todo https://wiki.libsdl.org/SDL3/SDL_DestroyGPURenderState
|
||||
/// @todo https://wiki.libsdl.org/SDL3/SDL_DestroyRenderer
|
||||
/// @todo SDL_CreateWindowAndRenderer
|
||||
/// @todo SDL_DestroyGPURenderState
|
||||
/// @todo SDL_DestroyRenderer
|
||||
/// Implemented in `../render.hpp` to avoid circular dependency with Texture
|
||||
Texture CreateTexture(SDL_PixelFormat format, SDL_TextureAccess access, int w, int h) const;
|
||||
/// Implemented in `../render.hpp` to avoid circular dependency with Texture
|
||||
Texture CreateTextureFromSurface(SDL_Surface* surface) const;
|
||||
/// Implemented in `../render.hpp` to avoid circular dependency with Texture
|
||||
Texture CreateTextureWithProperties(SDL_PropertiesID properties) const;
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_FlushRenderer
|
||||
* @brief Flush the current rendering commands to the screen.
|
||||
* @return bool True if the renderer was successfully flushed, false otherwise.
|
||||
*/
|
||||
bool Flush() const { return SDL_FlushRenderer(*this); }
|
||||
/// @todo https://wiki.libsdl.org/SDL3/SDL_GDKResumeRenderer
|
||||
/// @todo https://wiki.libsdl.org/SDL3/SDL_GDKSuspendRenderer
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetCurrentRenderOutputSize
|
||||
* @brief Get the output size in pixels of the current render target.
|
||||
* @param w A pointer to an int to be filled in with the width of the render output. If the renderer is invalid,
|
||||
* this will be set to 0.
|
||||
* @param h A pointer to an int to be filled in with the height of the render output. If the renderer is invalid,
|
||||
* this will be set to 0.
|
||||
* @return bool True if the output size was successfully retrieved, false otherwise.
|
||||
*/
|
||||
/// @todo SDL_GDKResumeRenderer
|
||||
/// @todo SDL_GDKSuspendRenderer
|
||||
bool GetOutputSize(int* w, int* h) const { return SDL_GetRenderOutputSize(*this, w, h); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetDefaultTextureScaleMode
|
||||
* @brief Get the default texture scale mode for the renderer.
|
||||
* @param scaleMode A pointer to an SDL_ScaleMode variable to be filled in with the default texture scale mode for
|
||||
* the renderer. If the renderer is invalid, this will be set to SDL_ScaleMode_None.
|
||||
* @return bool True if the default texture scale mode was successfully retrieved, false otherwise.
|
||||
*/
|
||||
bool GetDefaultTextureScaleMode(SDL_ScaleMode* scaleMode) const {
|
||||
return SDL_GetDefaultTextureScaleMode(*this, scaleMode);
|
||||
}
|
||||
/// @todo https://wiki.libsdl.org/SDL3/SDL_GetGPURendererDevice
|
||||
// https://wiki.libsdl.org/SDL3/SDL_GetNumRenderDrivers
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetRenderClipRect
|
||||
* @brief Get the clip rectangle for the current rendering target.
|
||||
* @param rect A pointer to an SDL_Rect structure to be filled in with the clip rectangle for the current
|
||||
* rendering target. If the renderer is invalid, this will be set to {0, 0, 0, 0}.
|
||||
* @return bool True if the clip rectangle was successfully retrieved, false otherwise.
|
||||
*/
|
||||
/// @todo SDL_GetGPURendererDevice
|
||||
static int GetNumRenderDrivers() { return SDL_GetNumRenderDrivers(); }
|
||||
|
||||
bool GetClipRect(SDL_Rect* rect) const { return SDL_GetRenderClipRect(*this, rect); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetRenderColorScale
|
||||
* @brief Get the color scale for the renderer.
|
||||
* @param scale A pointer to a float to be filled in with the color scale for the renderer. If the renderer is
|
||||
* invalid, this will be set to 0.0f.
|
||||
* @return bool True if the color scale was successfully retrieved, false otherwise.
|
||||
*/
|
||||
bool GetColorScale(float* scale) const { return SDL_GetRenderColorScale(*this, scale); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetRenderDrawBlendMode
|
||||
* @brief Get the blend mode used for drawing operations (Fill and Line).
|
||||
* @param blendMode A pointer to an SDL_BlendMode variable to be filled in with the blend mode used for drawing
|
||||
* operations. If the renderer is invalid, this will be set to SDL_BlendMode_None.
|
||||
* @return bool True if the blend mode was successfully retrieved, false otherwise.
|
||||
*/
|
||||
bool GetDrawBlendMode(SDL_BlendMode* blendMode) const { return SDL_GetRenderDrawBlendMode(*this, blendMode); }
|
||||
/* @see https://wiki.libsdl.org/SDL3/SDL_GetRenderDrawColor
|
||||
* @brief Get the color used for drawing operations (Fill and Line).
|
||||
@@ -187,373 +141,109 @@ namespace hdk::sdl {
|
||||
bool GetSafeArea(SDL_Rect* rect) const { return SDL_GetRenderSafeArea(*this, rect); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetRenderScale
|
||||
* @brief Get the scale of the current render target.
|
||||
* @param scaleX A pointer to a float to be filled in with the horizontal scale factor.
|
||||
* @param scaleX A pointer to a float to be filled in with the horizontal scale factor.
|
||||
* @param scaleY A pointer to a float to be filled in with the vertical scale factor.
|
||||
* @return bool True on success
|
||||
*/
|
||||
bool GetScale(float* scaleX, float* scaleY) const { return SDL_GetRenderScale(*this, scaleX, scaleY); }
|
||||
/**
|
||||
@todo https://wiki.libsdl.org/SDL3/SDL_GetRenderTarget
|
||||
**/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetRenderTextureAddressMode
|
||||
* @brief Get the texture address mode for the current render target.
|
||||
* @param u_mode A pointer to an SDL_TextureAddressMode variable
|
||||
* @param v_mode A pointer to an SDL_TextureAddressMode variable
|
||||
* @return bool True on success
|
||||
*/
|
||||
/// Implemented in `../render.hpp` to avoid circular dependency with Texture
|
||||
Texture GetRenderTarget() const;
|
||||
bool GetTextureAddressMode(SDL_TextureAddressMode* u_mode, SDL_TextureAddressMode* v_mode) const {
|
||||
return SDL_GetRenderTextureAddressMode(*this, u_mode, v_mode);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetRenderViewport
|
||||
* @brief Get the viewport for the current render target.
|
||||
* @param rect A pointer to an SDL_Rect structure to be filled in with the viewport
|
||||
* @return bool True on success
|
||||
*/
|
||||
bool GetViewport(SDL_Rect* rect) const { return SDL_GetRenderViewport(*this, rect); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetRenderVSync
|
||||
* @brief Get the vertical sync setting for the current renderer.
|
||||
* @param vsync A pointer to an int to store the vertical sync setting
|
||||
* @return bool True on success
|
||||
*/
|
||||
bool GetVSync(int* vsync) const { return SDL_GetRenderVSync(*this, vsync); }
|
||||
/**
|
||||
@todo https://wiki.libsdl.org/SDL3/SDL_GetRenderWindow
|
||||
**/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderClear
|
||||
* @brief Clear the current rendering target with the drawing color.
|
||||
* @return bool True if the renderer was successfully cleared, false otherwise.
|
||||
*/
|
||||
bool Clear() const { return SDL_RenderClear(*this); }
|
||||
//
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderClipEnabled
|
||||
* @brief Check whether clipping is enabled for the current render target.
|
||||
* @return bool True if clipping is enabled, false otherwise.
|
||||
*/
|
||||
// https://wiki.libsdl.org/SDL3/SDL_RenderCoordinatesFromWindow
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderCoordinatesFromWindow
|
||||
* @brief Convert window coordinates to renderer coordinates.
|
||||
* @param windowX The x coordinate in window space
|
||||
* @param windowY The y coordinate in window space
|
||||
* @param rendererX A pointer to a float to be filled in with the x coordinate
|
||||
* @param rendererY A pointer to a float to be filled in with the y coordinate
|
||||
* @return bool True if the coordinates were successfully converted, false otherwise.
|
||||
*/
|
||||
bool ClipEnabled() const { return SDL_RenderClipEnabled(*this); }
|
||||
bool CoordinatesFromWindow(float windowX, float windowY, float* rendererX, float* rendererY) const {
|
||||
return SDL_RenderCoordinatesFromWindow(*this, windowX, windowY, rendererX, rendererY);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderCoordinatesToWindow
|
||||
* @brief Convert renderer coordinates to window coordinates.
|
||||
* @param rendererX The x coordinate in renderer space
|
||||
* @param rendererY The y coordinate in renderer space
|
||||
* @param windowX A pointer to a float to be filled in with the x coordinate
|
||||
* @param windowY A pointer to a float to be filled in with the y coordinate
|
||||
* @return bool True if the coordinates were successfully converted, false otherwise.
|
||||
*/
|
||||
bool CoordinatesToWindow(float rendererX, float rendererY, float* windowX, float* windowY) const {
|
||||
return SDL_RenderCoordinatesToWindow(*this, rendererX, rendererY, windowX, windowY);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderDebugText
|
||||
* @brief Render debug text at a specific position in the current render target.
|
||||
* @param x The x coordinate of the text position
|
||||
* @param y The y coordinate of the text position
|
||||
* @param text The text to render
|
||||
* @return bool True if the text was successfully rendered, false otherwise.
|
||||
*/
|
||||
bool DebugText(float x, float y, const char* text) const { return SDL_RenderDebugText(*this, x, y, text); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderDebugTextFormat
|
||||
* @brief Render formatted debug text at a specific position in the current render target.
|
||||
* @param x The x coordinate of the text position
|
||||
* @param y The y coordinate of the text position
|
||||
* @param fmt The formatted text to render (printf-style format string)
|
||||
* @param args The arguments for the formatted text
|
||||
* @return bool True if the text was successfully rendered, false otherwise.
|
||||
*/
|
||||
template <typename... Args> bool DebugTextFormat(float x, float y, const char* fmt, Args... args) const {
|
||||
return SDL_RenderDebugTextFormat(*this, x, y, fmt, args...);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderFillRect
|
||||
* @brief fill rectangle with current draw color
|
||||
* @param rect pointer to rectangle to fill, or NULL to fill the entire render target
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool FillRect(const SDL_FRect* rect) const { return SDL_RenderFillRect(*this, rect); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderFillRects
|
||||
* @brief fill multiple rectangles with current draw color
|
||||
* @param rects pointer to array of rectangles to fill
|
||||
* @param count number of rectangles in the array
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool FillRects(const SDL_FRect* rects, int count) const { return SDL_RenderFillRects(*this, rects, count); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderGeometry
|
||||
* @brief Render geometry with the current render target
|
||||
* @param texture The texture to use for rendering
|
||||
* @param vertices Pointer to an array of vertices
|
||||
* @param numVertices Number of vertices in the array
|
||||
* @param indices Pointer to an array of indices
|
||||
* @param numIndices Number of indices in the array
|
||||
* @return bool True on success, false on failure
|
||||
*/
|
||||
bool RenderGeometry(
|
||||
SDL_Texture* texture, const SDL_Vertex* vertices, int numVertices, const int* indices, int numIndices) const {
|
||||
return SDL_RenderGeometry(*this, texture, vertices, numVertices, indices, numIndices);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderGeometryRaw
|
||||
* @brief render a list of triangles with optional texture and index data
|
||||
* @param texture The texture to use for rendering, or NULL for no texture
|
||||
* @param xy Pointer to an array of 2D vertex positions (x, y) in normalized coordinates (0.0 to 1.0)
|
||||
* @param xy_stride The byte stride between consecutive vertex positions in the xy array
|
||||
* @param color Pointer to an array of vertex colors
|
||||
* @param color_stride The byte stride between consecutive vertex colors in the color array
|
||||
* @param uv Pointer to an array of texture coordinates (u, v) in normalized coordinates (0.0 to 1.0), or NULL if
|
||||
* not using textures
|
||||
* @param uv_stride The byte stride between consecutive texture coordinates in the uv array
|
||||
* @param numVertices The number of vertices in the xy, color, and uv arrays
|
||||
* @param indices Pointer to an array of vertex indices that define the triangles to render, or NULL to render the
|
||||
* vertices in sequential order
|
||||
* @param numIndices The number of indices
|
||||
* @param sizeIndices The byte size of each index in the indices array (1, 2, or 4 bytes)
|
||||
* @return bool True on success
|
||||
*/
|
||||
bool RenderGeometryRaw(SDL_Texture* texture, const float* xy, int xy_stride, const SDL_FColor* color,
|
||||
int color_stride, const float* uv, int uv_stride, int numVertices, const void* indices, int numIndices,
|
||||
int sizeIndices) const {
|
||||
return SDL_RenderGeometryRaw(*this, texture, xy, xy_stride, color, color_stride, uv, uv_stride, numVertices,
|
||||
indices, numIndices, sizeIndices);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderLine
|
||||
* @brief render line with current draw color
|
||||
* @param x1
|
||||
* @param y1
|
||||
* @param x2
|
||||
* @param y2
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool RenderLine(float x1, float y1, float x2, float y2) const { return SDL_RenderLine(*this, x1, y1, x2, y2); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderLines
|
||||
* @brief render multiple lines with current draw color
|
||||
* @param points
|
||||
* @param count number of points in the array
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool RenderLines(const SDL_FPoint* points, int count) const { return SDL_RenderLines(*this, points, count); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderPoint
|
||||
* @brief render point with current draw color
|
||||
* @param x
|
||||
* @param y
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool RenderPoint(float x, float y) const { return SDL_RenderPoint(*this, x, y); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderPoints
|
||||
* @brief render multiple points with current draw color
|
||||
* @param points
|
||||
* @param count number of points in the array
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool RenderPoints(const SDL_FPoint* points, int count) const { return SDL_RenderPoints(*this, points, count); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderPresent
|
||||
* @brief Update the screen with any rendering performed since the previous call.
|
||||
* @return bool True if the screen was successfully updated, false otherwise.
|
||||
*/
|
||||
bool Present() const { return SDL_RenderPresent(*this); }
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_RenderReadPixels */
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderRect
|
||||
* @brief render rectangle outline with current draw color
|
||||
* @param rect pointer to rectangle to outline, or NULL to outline the entire render target
|
||||
* @return bool true on success
|
||||
*/
|
||||
Surface ReadPixels(const SDL_Rect* rect) const {
|
||||
return Surface(Surface::get_or_cache(SDL_RenderReadPixels(*this, rect), SDL_DestroySurface));
|
||||
}
|
||||
|
||||
bool RenderRect(const SDL_FRect* rect) const { return SDL_RenderRect(*this, rect); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderRects
|
||||
* @brief render multiple rectangle outlines with current draw color
|
||||
* @param rects pointer to array of rectangles to outline
|
||||
* @param count number of rectangles in the array
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool RenderRects(const SDL_FRect* rects, int count) const { return SDL_RenderRects(*this, rects, count); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderTexture
|
||||
* @brief Render texture
|
||||
* @param texture
|
||||
* @param src
|
||||
* @param dst
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool RenderTexture(SDL_Texture* texture, const SDL_FRect* src, const SDL_FRect* dst) const {
|
||||
return SDL_RenderTexture(*this, texture, src, dst);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderTexture9Grid
|
||||
* @brief Render a texture with 9-grid scaling
|
||||
* @param texture
|
||||
* @param src
|
||||
* @param left_width
|
||||
* @param right_width
|
||||
* @param top_height
|
||||
* @param bottom_height
|
||||
* @param scale
|
||||
* @param dst
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool RenderTexture9Grid(SDL_Texture* texture, const SDL_FRect* src, float left_width, float right_width,
|
||||
float top_height, float bottom_height, float scale, const SDL_FRect* dst) const {
|
||||
return SDL_RenderTexture9Grid(
|
||||
*this, texture, src, left_width, right_width, top_height, bottom_height, scale, dst);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderTexture9GridTiled
|
||||
* @brief Render a texture with 9-grid scaling and tiling
|
||||
* @param texture
|
||||
* @param src
|
||||
* @param left_width
|
||||
* @param right_width
|
||||
* @param top_height
|
||||
* @param bottom_height
|
||||
* @param scale
|
||||
* @param dst
|
||||
* @param tile_scale
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool RenderTexture9GridTiled(SDL_Texture* texture, const SDL_FRect* src, float left_width, float right_width,
|
||||
float top_height, float bottom_height, float scale, const SDL_FRect* dst, float tile_scale) const {
|
||||
return SDL_RenderTexture9GridTiled(
|
||||
*this, texture, src, left_width, right_width, top_height, bottom_height, scale, dst, tile_scale);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderTextureAffine
|
||||
* @brief Render a texture with affine transformations
|
||||
* @param texture
|
||||
* @param src
|
||||
* @param origin
|
||||
* @param right
|
||||
* @param down
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool RenderTextureAffine(SDL_Texture* texture, const SDL_FRect* src, const SDL_FPoint* origin,
|
||||
const SDL_FPoint* right, const SDL_FPoint* down) const {
|
||||
return SDL_RenderTextureAffine(*this, texture, src, origin, right, down);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderTextureRotated
|
||||
* @brief Render a texture with rotation and flipping
|
||||
* @param texture
|
||||
* @param srcrect
|
||||
* @param dstrect
|
||||
* @param angle
|
||||
* @param center
|
||||
* @param flip
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool RenderTextureRotated(SDL_Texture* texture, const SDL_FRect* srcrect, const SDL_FRect* dstrect, double angle,
|
||||
const SDL_FPoint* center, SDL_FlipMode flip) const {
|
||||
return SDL_RenderTextureRotated(*this, texture, srcrect, dstrect, angle, center, flip);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_RenderTextureTiled
|
||||
* @brief Render a texture with tiling
|
||||
* @param texture
|
||||
* @param srcrect
|
||||
* @param scale
|
||||
* @param dstrect
|
||||
* @param tile_scale
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool RenderTextureTiled(
|
||||
SDL_Texture* texture, const SDL_FRect* srcrect, float scale, const SDL_FRect* dstrect, float tile_scale) const {
|
||||
return SDL_RenderTextureTiled(*this, texture, srcrect, scale, dstrect);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetDefaultTextureScaleMode
|
||||
* @brief Set the default texture scale mode for the renderer.
|
||||
* @param scaleMode The default texture scale mode for the renderer.
|
||||
* @return bool True if the default texture scale mode was successfully set, false otherwise.
|
||||
*/
|
||||
bool SetDefaultTextureScaleMode(SDL_ScaleMode scaleMode) const {
|
||||
return SDL_SetDefaultTextureScaleMode(*this, scaleMode);
|
||||
}
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_SetGPURenderState
|
||||
/** @todo SDL_SetGPURenderState
|
||||
// https://wiki.libsdl.org/SDL3/SDL_SetGPURenderStateFragmentUniforms
|
||||
// https://wiki.libsdl.org/SDL3/SDL_SetGPURenderStateSamplerBindings
|
||||
// https://wiki.libsdl.org/SDL3/SDL_SetGPURenderStateStorageBuffers
|
||||
// https://wiki.libsdl.org/SDL3/SDL_SetGPURenderStateStorageTextures
|
||||
**/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetRenderClipRect
|
||||
* @brief Set the clip rectangle for the current rendering target.
|
||||
* @param rect
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetClipRect(const SDL_Rect* rect) const { return SDL_SetRenderClipRect(*this, rect); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetRenderColorScale
|
||||
* @brief Set the color scale for the renderer.
|
||||
* @param scale The color scale for the renderer.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetRenderColorScale(float scale) const { return SDL_SetRenderColorScale(*this, scale); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetRenderDrawBlendMode
|
||||
* @brief Set the blend mode used for drawing operations (Fill and Line).
|
||||
* @param blendMode The blend mode used for drawing operations.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetDrawBlendMode(SDL_BlendMode blendMode) const { return SDL_SetRenderDrawBlendMode(*this, blendMode); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetRenderDrawColor
|
||||
* @brief Set the color used for drawing operations (Fill and Line).
|
||||
* @param r The red component of the drawing color
|
||||
* @param g The green component of the drawing color
|
||||
* @param b The blue component of the drawing color
|
||||
* @param a The alpha component of the drawing color
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetDrawColor(Uint8 r, Uint8 g, Uint8 b, Uint8 a) const {
|
||||
return SDL_SetRenderDrawColor(*this, r, g, b, a);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetRenderDrawColorFloat
|
||||
* @brief Set the color used for drawing operations (Fill and Line) as floats.
|
||||
* @param r The red component of the drawing color
|
||||
* @param g The green component of the drawing color
|
||||
* @param b The blue component of the drawing color
|
||||
* @param a The alpha component of the drawing color
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetDrawColor(Uint8 r, Uint8 g, Uint8 b, Uint8 a) const { return SDL_SetRenderDrawColor(*this, r, g, b, a); }
|
||||
bool SetDrawColorFloat(float r, float g, float b, float a) const {
|
||||
return SDL_SetRenderDrawColorFloat(*this, r, g, b, a);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetRenderLogicalPresentation
|
||||
* @brief Set the logical presentation for the renderer.
|
||||
* @param w The width of the logical presentation
|
||||
* @param h The height of the logical presentation
|
||||
* @param mode The presentation mode for the logical presentation
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetLogicalPresentation(int w, int h, SDL_RendererLogicalPresentation mode) const {
|
||||
return SDL_SetRenderLogicalPresentation(*this, w, h, mode);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetRenderScale
|
||||
* @brief Set the scale for the current render target.
|
||||
* @param scaleX The horizontal scale factor
|
||||
* @param scaleY The vertical scale factor
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetScale(float scaleX, float scaleY) const { return SDL_SetRenderScale(*this, scaleX, scaleY); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetRenderTarget
|
||||
* @brief Set the render target to a texture or the default render target.
|
||||
* @param texture The texture to set as the render target, or NULL to set the default render target
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetRenderTarget(SDL_Texture* texture) const { return SDL_SetRenderTarget(*this, texture); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetRenderTextureAddressMode
|
||||
* @brief Set the texture address mode for the current render target.
|
||||
* @param u_mode The texture address mode for the horizontal direction
|
||||
* @param v_mode The texture address mode for the vertical direction
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetTextureAddressMode(SDL_TextureAddressMode u_mode, SDL_TextureAddressMode v_mode) const {
|
||||
return SDL_SetRenderTextureAddressMode(*this, u_mode, v_mode);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetRenderViewport
|
||||
* @brief Set the viewport for the current render target.
|
||||
* @param rect A pointer to an SDL_Rect structure representing the viewport, or NULL to use the entire render
|
||||
* target.
|
||||
* @return bool True if the viewport was successfully set, false otherwise.
|
||||
*/
|
||||
bool ViewportSet() const { return SDL_RenderViewportSet(*this); }
|
||||
bool SetViewport(const SDL_Rect* rect) const { return SDL_SetRenderViewport(*this, rect); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetRenderVSync
|
||||
* @brief Set the vertical sync setting for the current renderer.
|
||||
* @param vsync The vertical sync setting to use (0 for no vsync, 1 for vsync, -1 for adaptive vsync)
|
||||
* @return bool True on success, false on failure
|
||||
*/
|
||||
bool SetVSync(int vsync) const { return SDL_SetRenderVSync(*this, vsync); }
|
||||
/// Forward declare: implemented in ../video.hpp to avoid circular dependency
|
||||
bool SetVSync(int vsync) const { return SDL_SetRenderVSync(*this, vsync); }
|
||||
/// Implemented in ../video.hpp to avoid circular dependency
|
||||
Window GetWindow() const;
|
||||
};
|
||||
}
|
||||
@@ -1,11 +1,10 @@
|
||||
#pragma once
|
||||
/** @file Texture.hpp
|
||||
* @brief HDK sdl video header only wrapper for SDL_Texture struct & related functions
|
||||
*/
|
||||
/// @file Texture.hpp
|
||||
/// For complete documentation, see src/render/Texture.cpp
|
||||
#include <SDL3/SDL.h>
|
||||
#include <hdk/grid/SharedPtrWrapper.hpp>
|
||||
#include <hdk/sdl/Properties.hpp>
|
||||
/** Textures are used to store pixel data that can be rendered by a renderer. */
|
||||
#include <hdk/sdl/pixels/Palette.hpp>
|
||||
namespace hdk::sdl {
|
||||
/// Forward declare to avoid circular dependency with Renderer
|
||||
class Renderer;
|
||||
@@ -13,226 +12,68 @@ namespace hdk::sdl {
|
||||
class Texture : public hdk::grid::SharedPtrWrapper<SDL_Texture> {
|
||||
public:
|
||||
friend class Renderer;
|
||||
/** Inherit constructors from SharedPtrWrapper */
|
||||
using hdk::grid::SharedPtrWrapper<SDL_Texture>::SharedPtrWrapper;
|
||||
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_CreateTexture
|
||||
* @brief Create a texture for a rendering context.
|
||||
* @param renderer The rendering context to create the texture for.
|
||||
* @param format The pixel format of the texture
|
||||
* @param access The access pattern for the texture
|
||||
* @param w The width of the texture in pixels
|
||||
* @param h The height of the texture in pixels
|
||||
* @return Texture The created texture. If the creation fails, returns an invalid texture.
|
||||
*/
|
||||
static Texture Create(SDL_Renderer* renderer, SDL_PixelFormat format, SDL_TextureAccess access, int w, int h) {
|
||||
return Texture(get_or_cache(SDL_CreateTexture(renderer, format, access, w, h), SDL_DestroyTexture));
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_CreateTextureFromSurface
|
||||
* @brief Create a texture from an existing surface.
|
||||
* @param renderer The rendering context to create the texture for.
|
||||
* @param surface The surface to create the texture from.
|
||||
* @return Texture The created texture. If the creation fails, returns an invalid texture.
|
||||
*/
|
||||
static Texture CreateFromSurface(SDL_Renderer* renderer, SDL_Surface* surface) {
|
||||
return Texture(get_or_cache(SDL_CreateTextureFromSurface(renderer, surface), SDL_DestroyTexture));
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_CreateTextureWithProperties
|
||||
* @brief Create a texture for a rendering context with specific properties.
|
||||
* @param renderer The rendering context to create the texture for.
|
||||
* @param properties The properties to create the texture with.
|
||||
* @return Texture The created texture. If the creation fails, returns an invalid texture.
|
||||
*/
|
||||
static Texture CreateWithProperties(SDL_Renderer* renderer, SDL_PropertiesID properties) {
|
||||
return Texture(get_or_cache(SDL_CreateTextureWithProperties(renderer, properties), SDL_DestroyTexture));
|
||||
}
|
||||
// https://wiki.libsdl.org/SDL3/SDL_DestroyTexture
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetTextureAlphaMod
|
||||
* @brief Get the alpha modulation value for a texture.
|
||||
* @param alpha A pointer to an int
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetAlphaMod(Uint8* alpha) const { return SDL_GetTextureAlphaMod(*this, alpha); }
|
||||
Uint8 GetAlphaMod() const {
|
||||
Uint8 alpha;
|
||||
SDL_GetTextureAlphaMod(*this, &alpha);
|
||||
return alpha;
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetTextureAlphaModFloat
|
||||
* @brief Get the alpha modulation value for a texture as a float.
|
||||
* @param alpha A pointer to a float
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetAlphaModFloat(float* alpha) const { return SDL_GetTextureAlphaModFloat(*this, alpha); }
|
||||
float GetAlphaModFloat() const {
|
||||
float alpha;
|
||||
SDL_GetTextureAlphaModFloat(*this, &alpha);
|
||||
return alpha;
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetTextureBlendMode
|
||||
* @brief Get the blend mode for a texture.
|
||||
* @param blendMode A pointer to an SDL_BlendMode variable to be filled in
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetBlendMode(SDL_BlendMode* blendMode) const { return SDL_GetTextureBlendMode(*this, blendMode); }
|
||||
SDL_BlendMode GetBlendMode() const {
|
||||
SDL_BlendMode blendMode;
|
||||
SDL_GetTextureBlendMode(*this, &blendMode);
|
||||
return blendMode;
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetTextureColorMod
|
||||
* @brief Get the color modulation values for a texture.
|
||||
* @param r A pointer to a Uint8 to be filled in with the red color
|
||||
* @param g A pointer to a Uint8 to be filled in with the green color
|
||||
* @param b A pointer to a Uint8 to be filled in with the blue color
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetColorMod(Uint8* r, Uint8* g, Uint8* b) const { return SDL_GetTextureColorMod(*this, r, g, b); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetTextureColorModFloat
|
||||
* @brief Get the color modulation values for a texture as floats.
|
||||
* @param r A pointer to a float to be filled in with the red color
|
||||
* @param g A pointer to a float to be filled in with the green color
|
||||
* @param b A pointer to a float to be filled in with the blue color
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetColorModFloat(float* r, float* g, float* b) const { return SDL_GetTextureColorModFloat(*this, r, g, b); }
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_GetTexturePalette **/
|
||||
/** https://wiki.libsdl.org/SDL3/SDL_GetTextureProperties
|
||||
* @brief Get the properties of a texture.
|
||||
* @returns Properties associated with the texture.
|
||||
*/
|
||||
Palette GetPalette() const { return Palette(Palette::get_or_cache(SDL_GetTexturePalette(*this), SDL_DestroyPalette)); }
|
||||
Properties GetProperties() const { return Properties(SDL_GetTextureProperties(*this)); }
|
||||
/// Implemented in `../render.hpp` to avoid circular dependency with Renderer
|
||||
Renderer GetRenderer() const;
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetTextureScaleMode
|
||||
* @brief Get the scale mode for a texture.
|
||||
* @param scaleMode A pointer to an SDL_ScaleMode variable to be filled in
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetScaleMode(SDL_ScaleMode* scaleMode) const { return SDL_GetTextureScaleMode(*this, scaleMode); }
|
||||
SDL_ScaleMode GetScaleMode() const {
|
||||
SDL_ScaleMode scaleMode;
|
||||
SDL_GetTextureScaleMode(*this, &scaleMode);
|
||||
return scaleMode;
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetTextureSize
|
||||
* @brief Get the size of a texture.
|
||||
* @param w A pointer to a float to be filled in with the width
|
||||
* @param h A pointer to a float to be filled in with the height
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool GetSize(float* w, float* h) const { return SDL_GetTextureSize(*this, w, h); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_LockTexture
|
||||
* @brief Lock a portion of the texture for write-only pixel access.
|
||||
* @param rect A pointer to an SDL_Rect structure representing the area to lock, or NULL to lock the entire
|
||||
* texture.
|
||||
* @param pixels A pointer to a void* to be filled in with the locked pixels. You can cast this to the appropriate
|
||||
* type based on the texture's pixel format.
|
||||
* @param pitch A pointer to an int to be filled in with the pitch of the locked pixels (the length of a row of
|
||||
* pixels in bytes).
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool Lock(const SDL_Rect* rect, void** pixels, int* pitch) const {
|
||||
return SDL_LockTexture(*this, rect, pixels, pitch);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_LockTextureToSurface
|
||||
* @brief Lock a portion of the texture for write-only pixel access and create an SDL_Surface that can be used to
|
||||
* access the pixels.
|
||||
* @param rect A pointer to an SDL_Rect structure representing the area to lock, or NULL to lock the entire
|
||||
* texture.
|
||||
* @param surface A pointer to an SDL_Surface* to be filled in with the created surface. You must free this
|
||||
* surface with SDL_FreeSurface when you are done with it.
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool LockToSurface(const SDL_Rect* rect, SDL_Surface** surface) const {
|
||||
return SDL_LockTextureToSurface(*this, rect, surface);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetTextureAlphaMod
|
||||
* @brief Set the alpha modulation value for a texture.
|
||||
* @param alpha The alpha modulation value to set
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetAlphaMod(Uint8 alpha) const { return SDL_SetTextureAlphaMod(*this, alpha); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetTextureAlphaModFloat
|
||||
* @brief Set the alpha modulation value for a texture as a float.
|
||||
* @param alpha The alpha modulation value to set
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetAlphaModFloat(float alpha) const { return SDL_SetTextureAlphaModFloat(*this, alpha); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetTextureBlendMode
|
||||
* @brief Set the blend mode for a texture.
|
||||
* @param blendMode The blend mode to set
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetBlendMode(SDL_BlendMode blendMode) const { return SDL_SetTextureBlendMode(*this, blendMode); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetTextureColorMod
|
||||
* @brief Set the color modulation values for a texture.
|
||||
* @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_SetTextureColorMod(*this, r, g, b); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetTextureColorModFloat
|
||||
* @brief Set the color modulation values for a texture as floats.
|
||||
* @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 SetColorModFloat(float r, float g, float b) const { return SDL_SetTextureColorModFloat(*this, r, g, b); }
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_SetTexturePalette **/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_SetTextureScaleMode
|
||||
* @brief Set the scale mode for a texture.
|
||||
* @param scaleMode The scale mode to set
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool SetPalette(SDL_Palette* palette) const { return SDL_SetTexturePalette(*this, palette); }
|
||||
bool SetScaleMode(SDL_ScaleMode scaleMode) const { return SDL_SetTextureScaleMode(*this, scaleMode); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_UnlockTexture
|
||||
* @brief Unlock a texture, enabling the changes made to the texture's pixels to be rendered.
|
||||
*/
|
||||
void Unlock() const { SDL_UnlockTexture(*this); }
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_UpdateNVTexture
|
||||
* @brief Update a rectangle within a texture with new pixel data in NV12 or NV21 format.
|
||||
* @param rect A pointer to an SDL_Rect structure representing the area to update, or NULL to update the entire
|
||||
* texture.
|
||||
* @param Yplane A pointer to the pixel data for the Y plane of the texture. The format of this data should be a
|
||||
* contiguous array of bytes, where each byte represents the intensity of the Y component for a pixel.
|
||||
* @param Ypitch The pitch of the Y plane pixel data (the length of a row of pixels in bytes).
|
||||
* @param UVplane A pointer to the pixel data for the interleaved U and V planes of the texture. The format of
|
||||
* this data should be a contiguous array of bytes, where each pair of bytes represents the U and V components for
|
||||
* a pixel. The U and V values should be interleaved, meaning that the first byte represents the U component and
|
||||
* the second byte represents the V component for a pixel.
|
||||
* @param UVpitch The pitch of the interleaved U and V plane pixel data (the length of a row of pixels in bytes).
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool UpdateNV(const SDL_Rect* rect, const Uint8* Yplane, int Ypitch, const Uint8* UVplane, int UVpitch) const {
|
||||
return SDL_UpdateNVTexture(*this, rect, Yplane, Ypitch, UVplane, UVpitch);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_UpdateTexture
|
||||
* @brief Update a rectangle within a texture with new pixel data.
|
||||
* @param rect A pointer to an SDL_Rect structure representing the area to update, or NULL to update the entire
|
||||
* texture.
|
||||
* @param pixels A pointer to the pixel data to update the texture with. The format of this data should match the
|
||||
* pixel format of the texture.
|
||||
* @param pitch The pitch of the pixel data (the length of a row of pixels in bytes).
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool Update(const SDL_Rect* rect, const void* pixels, int pitch) const {
|
||||
return SDL_UpdateTexture(*this, rect, pixels, pitch);
|
||||
}
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_UpdateYUVTexture
|
||||
* @brief Update a rectangle within a texture
|
||||
* @param rect A pointer to an SDL_Rect structure representing the area to update, or NULL to update the entire
|
||||
* texture.
|
||||
* @param Yplane A pointer to the pixel data for the Y plane of the texture.
|
||||
* @param Ypitch The pitch of the Y plane pixel data (the length of a row of pixels in bytes).
|
||||
* @param Uplane A pointer to the pixel data for the U plane of the texture.
|
||||
* @param Upitch The pitch of the U plane pixel data (the length of a row of pixels in bytes).
|
||||
* @param Vplane A pointer to the pixel data for the V plane of the texture.
|
||||
* @param Vpitch The pitch of the V plane pixel data (the length of a row of pixels in bytes).
|
||||
* @return bool true on success
|
||||
*/
|
||||
bool UpdateYUV(const SDL_Rect* rect, const Uint8* Yplane, int Ypitch, const Uint8* Uplane, int Upitch, const Uint8* Vplane, int Vpitch) const {
|
||||
return SDL_UpdateYUVTexture(*this, rect, Yplane, Ypitch, Uplane, Upitch, Vplane, Vpitch);
|
||||
}
|
||||
|
||||
@@ -1,9 +1,6 @@
|
||||
#pragma once
|
||||
/**
|
||||
* @file video.hpp
|
||||
* @brief Marries the two classes together resolving what would otherwise be circular dependencies between Window and
|
||||
* Renderer
|
||||
*/
|
||||
/// @file video.hpp
|
||||
/// For complete documentation, see src/video.cpp
|
||||
#include <hdk/sdl/video/Display.hpp>
|
||||
#include <hdk/sdl/video/Surface.hpp>
|
||||
#include <hdk/sdl/video/Window.hpp>
|
||||
@@ -13,26 +10,8 @@
|
||||
#include <hdk/sdl/render/Renderer.hpp>
|
||||
|
||||
namespace hdk::sdl {
|
||||
/** @see SDL_GetRenderer
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetRenderer
|
||||
* @brief Get the renderer associated with a window.
|
||||
* @return Renderer The renderer associated with the window. If the window is invalid or has no renderer, returns an
|
||||
* invalid renderer.
|
||||
*/
|
||||
inline Renderer Window::GetRenderer() const { return Renderer(Renderer::get_or_view(SDL_GetRenderer(*this))); }
|
||||
/** @see SDL_GetRenderWindow
|
||||
* https://wiki.libsdl.org/SDL3/SDL_GetRenderWindow
|
||||
*/
|
||||
inline Window Renderer::GetWindow() const { return Window(Window::get_or_view(SDL_GetRenderWindow(*this))); }
|
||||
/** @see SDL_CreateWindowAndRenderer
|
||||
* https://wiki.libsdl.org/SDL3/SDL_CreateWindowAndRenderer
|
||||
* @brief Create a window and renderer with one function call.
|
||||
* @param title
|
||||
* @param width
|
||||
* @param height
|
||||
* @param window_flags
|
||||
* @return std::pair<Window, Renderer>
|
||||
*/
|
||||
inline std::pair<Window, Renderer> CreateWindowAndRenderer(
|
||||
const char* title, int width, int height, SDL_WindowFlags window_flags) {
|
||||
SDL_Window* window_ptr = nullptr;
|
||||
@@ -44,4 +23,7 @@ namespace hdk::sdl {
|
||||
return { Window(nullptr), Renderer(nullptr) };
|
||||
}
|
||||
}
|
||||
inline Palette Surface::CreatePalette() const {
|
||||
return Palette::get_or_cache(SDL_CreateSurfacePalette(*this), SDL_DestroyPalette);
|
||||
}
|
||||
}
|
||||
@@ -1,100 +1,28 @@
|
||||
#pragma once
|
||||
/**
|
||||
* @file Display.hpp
|
||||
* @brief HDK sdl video header only wrapper for the SDL_DisplayID type and related functions
|
||||
*/
|
||||
/// @file Display.hpp
|
||||
/// For complete documentation, see src/video/Display.cpp
|
||||
#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
|
||||
@@ -112,19 +40,7 @@ namespace hdk::sdl {
|
||||
}
|
||||
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
|
||||
@@ -142,15 +58,7 @@ namespace hdk::sdl {
|
||||
}
|
||||
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()); }
|
||||
};
|
||||
}
|
||||
@@ -1,199 +1,83 @@
|
||||
#pragma once
|
||||
/** @file Surface.hpp
|
||||
* @brief Defines the Surface class for handling SDL surfaces.
|
||||
*/
|
||||
/// @file Surface.hpp
|
||||
/// For complete documentation, see src/video/Surface.cpp
|
||||
#include <SDL3/SDL.h>
|
||||
#include <hdk/grid/SharedPtrWrapper.hpp>
|
||||
/** Surfaces hold bitmap data **/
|
||||
#include <list>
|
||||
namespace hdk::sdl {
|
||||
class Palette;
|
||||
|
||||
class Surface : public hdk::grid::SharedPtrWrapper<SDL_Surface> {
|
||||
public:
|
||||
/** Inherit constructors from SharedPtrWrapper */
|
||||
friend class Renderer;
|
||||
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
|
||||
*/
|
||||
bool BlitUncheckedTo(SDL_Surface* dst_surface, const SDL_Rect* dst_rect = nullptr, const SDL_Rect* src_rect = nullptr) const {
|
||||
return SDL_BlitSurfaceUnchecked(*this, src_rect, dst_surface, dst_rect);
|
||||
}
|
||||
bool BlitUncheckedFrom(SDL_Surface* src_surface, const SDL_Rect* src_rect = nullptr, const SDL_Rect* dst_rect = nullptr) const {
|
||||
return SDL_BlitSurfaceUnchecked(src_surface, src_rect, *this, dst_rect);
|
||||
}
|
||||
bool BlitUncheckedScaledTo(SDL_Surface* dst_surface, const SDL_Rect* dst_rect, SDL_ScaleMode scale_mode,
|
||||
const SDL_Rect* src_rect = nullptr) const {
|
||||
return SDL_BlitSurfaceUncheckedScaled(*this, src_rect, dst_surface, dst_rect, scale_mode);
|
||||
}
|
||||
bool BlitUncheckedScaledFrom(SDL_Surface* src_surface, const SDL_Rect* src_rect, SDL_ScaleMode scale_mode,
|
||||
const SDL_Rect* dst_rect = nullptr) const {
|
||||
return SDL_BlitSurfaceUncheckedScaled(src_surface, src_rect, *this, dst_rect, scale_mode);
|
||||
}
|
||||
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(
|
||||
@@ -221,7 +105,11 @@ namespace hdk::sdl {
|
||||
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_CreateSurfacePalette
|
||||
* @brief Create a new surface with a palette.
|
||||
* @returns a new pallet on success or nullptr on failure
|
||||
*/
|
||||
Palette CreatePalette() const;
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_DestroySurface
|
||||
*/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_DuplicateSurface
|
||||
@@ -289,8 +177,27 @@ namespace hdk::sdl {
|
||||
* @return The colorspace of the surface.
|
||||
*/
|
||||
SDL_Colorspace GetColorspace() const { return SDL_GetSurfaceColorspace(*this); }
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_GetSurfaceImages
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetSurfaceImages
|
||||
* @brief Get the surface's alternative images.
|
||||
* @param count pointer to an int variable to receive the number of alternative images
|
||||
* @return An array of Surface instances representing the surface's alternative images, or nullptr
|
||||
*/
|
||||
SDL_Surface** GetImages(int* count) const { return SDL_GetSurfaceImages(*this, count); }
|
||||
/**
|
||||
* @brief Get the surface's alternative images as a list.
|
||||
* @return A list of Surface instances representing the surface's alternative images.
|
||||
*/
|
||||
std::list<Surface> GetImages() const {
|
||||
int count = 0;
|
||||
SDL_Surface** images = GetImages(&count);
|
||||
std::list<Surface> image_list;
|
||||
for (int i = 0; i < count; ++i) {
|
||||
image_list.emplace_back(get_or_cache(images[i], SDL_DestroySurface));
|
||||
}
|
||||
SDL_free(images);
|
||||
return image_list;
|
||||
}
|
||||
|
||||
/** @todo https://wiki.libsdl.org/SDL3/SDL_GetSurfacePalette
|
||||
*/
|
||||
/** @see https://wiki.libsdl.org/SDL3/SDL_GetSurfaceProperties
|
||||
|
||||
@@ -1,62 +1,35 @@
|
||||
#pragma once
|
||||
/**
|
||||
* @file Window.hpp
|
||||
* @brief HDK sdl video header only wrapper for SDL_Window struct & related functions
|
||||
*/
|
||||
/// @file Window.hpp
|
||||
/// For complete documentation, see src/video/Window.cpp
|
||||
#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 Renderer;
|
||||
namespace evt {
|
||||
class EventConduit;
|
||||
}
|
||||
class Window : public hdk::grid::SharedPtrWrapper<SDL_Window> {
|
||||
public:
|
||||
friend class Renderer;
|
||||
friend class evt::EventConduit;
|
||||
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).
|
||||
*/
|
||||
using hdk::grid::SharedPtrWrapper<SDL_Window>::get_or_cache;
|
||||
using hdk::grid::SharedPtrWrapper<SDL_Window>::get_or_view;
|
||||
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));
|
||||
}
|
||||
/** @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 */
|
||||
@@ -64,138 +37,29 @@ namespace hdk::sdl {
|
||||
}
|
||||
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user