candlewick::Window Struct Reference

RAII wrapper for the SDL_Window opaque type. More...

#include <candlewick/core/Window.h>

Public Member Functions
	Window (const char *title, Sint32 w, Sint32 h, SDL_WindowFlags flags)
	Standard constructor, which forwards to SDL_CreateWindow.
	Window (SDL_Window *ptr)
	This constructor takes ownership of the provided handle.
	Window (const Window &)=delete
	Window (Window &&other) noexcept
Window &	operator= (Window &&other) noexcept
	operator SDL_Window * () const
std::array< int, 2 >	size () const
std::array< int, 2 >	sizeInPixels () const
float	pixelDensity () const
float	displayScale () const
SDL_PixelFormat	pixelFormat () const
SDL_WindowFlags	flags () const
bool	setTitle (const char *title)
std::string_view	title () const
void	destroy () noexcept
	~Window () noexcept

Detailed Description

RAII wrapper for the SDL_Window opaque type.

Constructor & Destructor Documentation

Window() [1/4]

candlewick::Window::Window ( const char * title, Sint32 w, Sint32 h, SDL_WindowFlags flags )

inlineexplicit

Standard constructor, which forwards to SDL_CreateWindow.

Window() [2/4]

candlewick::Window::Window ( SDL_Window * ptr )

inlineexplicit

This constructor takes ownership of the provided handle.

Window() [3/4]

candlewick::Window::Window ( const Window & )

delete

Window() [4/4]

candlewick::Window::Window ( Window && other )

inlinenoexcept

~Window()

candlewick::Window::~Window ( )

inlinenoexcept

Member Function Documentation

destroy()

void candlewick::Window::destroy ( )

inlinenoexcept

displayScale()

float candlewick::Window::displayScale ( ) const

inline

flags()

SDL_WindowFlags candlewick::Window::flags ( ) const

inline

operator SDL_Window *()

candlewick::Window::operator SDL_Window * ( ) const

inline

operator=()

Window & candlewick::Window::operator= ( Window && other )

inlinenoexcept

pixelDensity()

float candlewick::Window::pixelDensity ( ) const

inline

pixelFormat()

SDL_PixelFormat candlewick::Window::pixelFormat ( ) const

inline

setTitle()

bool candlewick::Window::setTitle ( const char * title )

inline

size()

std::array< int, 2 > candlewick::Window::size ( ) const

inline

sizeInPixels()

std::array< int, 2 > candlewick::Window::sizeInPixels ( ) const

inline

title()

std::string_view candlewick::Window::title ( ) const

inline

---

The documentation for this struct was generated from the following file:

• src/candlewick/core/Window.h