Wrapper class to encapsulate creation and management of an SDL_Texture. More...

#include <texture.hpp>

Classes
struct	info
	Small wrapper that queries metadata about the provided texture. More...

Public Member Functions
	texture ()=default
	Default ctor. More...

	texture (SDL_Texture *txt)
	Assigns the given texture to this one. More...

	texture (const surface &surf, bool linear_interpolation=false)
	Construct a texture from a surface. More...

	texture (int w, int h, SDL_TextureAccess access)
	Construct a texture of the specified size and access type. More...

const info	get_info () const
	Queries metadata about the texture, such as its dimensions. More...

uint32_t	get_format () const
	The internal texture format. More...

int	get_access () const
	The texture access mode. More...

point	get_raw_size () const
	The raw internal texture size. More...

int	w () const
	The draw-space width of the texture, in pixels. More...

int	h () const
	The draw-space height of the texture, in pixels. More...

point	draw_size () const
	The size of the texture in draw-space. More...

void	set_draw_width (int w)
	Set the intended width of the texture, in draw-space. More...

void	set_draw_height (int h)
	Set the intended height of the texture, in draw-space. More...

void	set_draw_size (int w, int h)
	Set the intended size of the texture, in draw-space. More...

void	set_draw_size (const point &size)

const rect *	src () const
	A pointer to a rect indicating the source region of the underlying SDL_Texture to be used when drawing. More...

void	set_src (const rect &r)
	Set the source region of the texture used for drawing operations. More...

void	set_src_raw (const rect &r)
	Set the source region of the texture used for drawing operations. More...

void	clear_src ()
	Clear the source region. More...

void	set_alpha_mod (uint8_t alpha)
	Alpha modifier. More...

uint8_t	get_alpha_mod () const

void	set_blend_mode (SDL_BlendMode mode)
	Blend mode. More...

SDL_BlendMode	get_blend_mode () const

void	set_color_mod (uint8_t r, uint8_t g, uint8_t b)
	Colour modifier. More...

void	set_color_mod (const color_t &c)

color_t	get_color_mod () const

void	reset ()
	Releases ownership of the managed texture and resets the ptr to null. More...

void	reset (int width, int height, SDL_TextureAccess access)
	Releases ownership of the managed texture and creates a new one. More...

void	assign (SDL_Texture *t)
	Replaces ownership of the managed texture with the given one. More...

SDL_Texture *	get () const

bool	operator== (const texture &t) const
	Texture comparisons explicitly only care about the pointer value. More...

	operator SDL_Texture * () const

	operator bool () const

Private Member Functions
void	finalize ()

Private Attributes
std::shared_ptr< SDL_Texture >	texture_ = nullptr

point	size_ {0, 0}

bool	has_src_ = false
	true iff the source rect is valid More...

rect	src_
	uninitialized by default. More...

Detailed Description

Wrapper class to encapsulate creation and management of an SDL_Texture.

Supports free creation and creation from a surface.

Definition at line 32 of file texture.hpp.

Constructor & Destructor Documentation

◆ texture() [1/4]

texture::texture ( )

default

Default ctor.

Texture will be a nullptr.

◆ texture() [2/4]

texture::texture ( SDL_Texture * txt )

explicit

Assigns the given texture to this one.

Definition at line 40 of file texture.cpp.

References finalize(), and size_.

◆ texture() [3/4]

texture::texture	(	const surface &	surf,
		bool	linear_interpolation = `false`
	)

explicit

Construct a texture from a surface.

Parameters

surf	The surface to copy.
linear_interpolation	If true this texture will use linear interpolation when drawing. Otherwise nearest-neighbour interpolation is used. This does not affect texture creation, only later application.

Definition at line 49 of file texture.cpp.

References ERR_SDL, finalize(), video::get_renderer(), renderer(), set_texture_scale_quality(), size_, surf, and texture_.

◆ texture() [4/4]

texture::texture	(	int	w,
		int	h,
		SDL_TextureAccess	access
	)

Construct a texture of the specified size and access type.

Definition at line 78 of file texture.cpp.

References reset().

Member Function Documentation

◆ assign()

void texture::assign ( SDL_Texture * t )

Replaces ownership of the managed texture with the given one.

Definition at line 215 of file texture.cpp.

References get_raw_size(), has_src_, size_, t, and texture_.

◆ clear_src()

void texture::clear_src ( )

inline

Clear the source region.

Definition at line 165 of file texture.hpp.

References has_src_.

Referenced by gui::textbox::draw_contents(), display::expose(), gui2::window::expose(), and display::scroll().

◆ draw_size()

point texture::draw_size ( ) const

inline

The size of the texture in draw-space.

This may differ from the raw texture size. To get that in stead, use get_info() or get_raw_size().

Definition at line 120 of file texture.hpp.

References size_.

Referenced by gui2::canvas::draw(), video::read_pixels(), set_src(), font::floating_label::update(), display::update_render_textures(), and gui2::window::update_render_textures().

◆ finalize()

void texture::finalize ( )

private

Definition at line 84 of file texture.cpp.

References set_blend_mode().

Referenced by reset(), and texture().

◆ get()

SDL_Texture* texture::get ( ) const

inline

Definition at line 194 of file texture.hpp.

References texture_.

Referenced by operator==(), and video::read_pixels().

◆ get_access()

int texture::get_access ( ) const

The texture access mode.

Equivalent to get_info().access.

Definition at line 94 of file texture.cpp.

References texture::info::access, and get_info().

◆ get_alpha_mod()

uint8_t texture::get_alpha_mod ( ) const

Definition at line 135 of file texture.cpp.

References texture_.

◆ get_blend_mode()

SDL_BlendMode texture::get_blend_mode ( ) const

Definition at line 174 of file texture.cpp.

References b, and texture_.

◆ get_color_mod()

color_t texture::get_color_mod ( ) const

Definition at line 157 of file texture.cpp.

References c, and texture_.

◆ get_format()

uint32_t texture::get_format ( ) const

The internal texture format.

Equivalent to get_info().format.

Definition at line 89 of file texture.cpp.

References texture::info::format, and get_info().

◆ get_info()

const info texture::get_info ( ) const

inline

Queries metadata about the texture, such as its dimensions.

Definition at line 77 of file texture.hpp.

References lg::info().

Referenced by get_access(), get_format(), and get_raw_size().

◆ get_raw_size()

point texture::get_raw_size ( ) const

The raw internal texture size.

Equivalent to get_info().size.

Definition at line 99 of file texture.cpp.

References get_info(), and texture::info::size.

Referenced by assign(), image::prep_minimap_for_rendering(), video::read_pixels(), set_src(), set_src_raw(), draw::tiled_highres(), display::update_render_textures(), and gui2::window::update_render_textures().

◆ h()

int texture::h ( ) const

inline

The draw-space height of the texture, in pixels.

This will usually be the real texture height in pixels, but may differ in some situations. For high-DPI text, for example, it will usually be equal to get_info().size.y / pixel_scale.

Definition at line 112 of file texture.hpp.

References size_.

Referenced by gui::button::calculate_size(), gui2::image_shape::draw(), gui2::text_shape::draw(), gui::button::draw_contents(), gui::scrollbar::draw_contents(), gui::textbox::draw_contents(), font::floating_label::get_draw_size(), gui::button::load_images(), set_draw_height(), set_draw_size(), draw::tiled(), gui::tristate_button::tristate_button(), and gui::textbox::update_text_cache().

◆ operator bool()

texture::operator bool ( ) const

inlineexplicit

Definition at line 204 of file texture.hpp.

References texture_.

◆ operator SDL_Texture *()

texture::operator SDL_Texture * ( ) const

inline

Definition at line 199 of file texture.hpp.

References texture_.

◆ operator==()

bool texture::operator== ( const texture & t ) const

inline

Texture comparisons explicitly only care about the pointer value.

Definition at line 197 of file texture.hpp.

References get(), and t.

◆ reset() [1/2]

void texture::reset ( )

Releases ownership of the managed texture and resets the ptr to null.

Definition at line 184 of file texture.cpp.

References has_src_, size_, and texture_.

Referenced by editor::editor_display::clear_mouseover_hex_overlay(), font::floating_label::clear_texture(), display::fade_tod_mask(), gui::textbox::handle_event(), gui::button::load_images(), gui2::canvas::queue_reblur(), reset(), texture(), and gui2::canvas::update_blur().

◆ reset() [2/2]

void texture::reset	(	int	width,
		int	height,
		SDL_TextureAccess	access
	)

Releases ownership of the managed texture and creates a new one.

Definition at line 193 of file texture.cpp.

References ERR_SDL, finalize(), video::get_renderer(), has_src_, renderer(), reset(), size_, and texture_.

◆ set_alpha_mod()

void texture::set_alpha_mod ( uint8_t alpha )

Alpha modifier.

Multiplies alpha when drawing.

Definition at line 128 of file texture.cpp.

References texture_.

Referenced by font::floating_label::draw(), gui::textbox::draw_contents(), display::draw_hex(), and editor::editor_display::draw_hex().

◆ set_blend_mode()

void texture::set_blend_mode ( SDL_BlendMode mode )

Blend mode.

Modifies how draw operations are applied.

Definition at line 167 of file texture.cpp.

References b, and texture_.

Referenced by finalize().

◆ set_color_mod() [1/2]

void texture::set_color_mod ( const color_t & c )

Definition at line 145 of file texture.cpp.

References c, and set_color_mod().

◆ set_color_mod() [2/2]

void texture::set_color_mod	(	uint8_t	r,
		uint8_t	g,
		uint8_t	b
	)

Colour modifier.

Multiplies each colour component when drawing.

Definition at line 150 of file texture.cpp.

References b, g, and texture_.

Referenced by set_color_mod().

◆ set_draw_height()

void texture::set_draw_height ( int h )

inline

Set the intended height of the texture, in draw-space.

Definition at line 126 of file texture.hpp.

References h(), and size_.

◆ set_draw_size() [1/2]

void texture::set_draw_size ( const point & size )

inline

Definition at line 130 of file texture.hpp.

References utf8::size(), and size_.

◆ set_draw_size() [2/2]

void texture::set_draw_size	(	int	w,
		int	h
	)

inline

Set the intended size of the texture, in draw-space.

Definition at line 129 of file texture.hpp.

References h(), size_, and w().

Referenced by display::update_render_textures(), gui2::window::update_render_textures(), and font::pango_text::with_draw_scale().

◆ set_draw_width()

void texture::set_draw_width ( int w )

inline

Set the intended width of the texture, in draw-space.

Definition at line 123 of file texture.hpp.

References size_, and w().

◆ set_src()

void texture::set_src ( const rect & r )

Set the source region of the texture used for drawing operations.

This function operates in draw-space, and will be clipped to {0, 0, w(), h()}.

Definition at line 104 of file texture.cpp.

References draw_size(), get_raw_size(), has_src_, rect::intersect(), size_, and src_.

Referenced by gui::textbox::draw_contents(), display::expose(), gui2::window::expose(), and display::scroll().

◆ set_src_raw()

void texture::set_src_raw ( const rect & r )

Set the source region of the texture used for drawing operations.

This function operates in texture-space, and will be clipped to {0, 0, get_raw_size().x, get_raw_size().y}.

Definition at line 121 of file texture.cpp.

References get_raw_size(), has_src_, rect::intersect(), and src_.

◆ src()

const rect* texture::src ( ) const

inline

A pointer to a rect indicating the source region of the underlying SDL_Texture to be used when drawing.

If null, the whole SDL_Texture should be used.

It should generally not be queried directly. Set it using set_src() or set_src_raw(). Clear it using clear_src().

Definition at line 146 of file texture.hpp.

References has_src_, and src_.

Referenced by draw::blit(), and draw::flipped().

◆ w()

int texture::w ( ) const

inline

The draw-space width of the texture, in pixels.

This will usually be the real texture width in pixels, but may differ in some situations. For high-DPI text, for example, it will usually be equal to get_info().size.x / pixel_scale.

Definition at line 103 of file texture.hpp.

References size_.

Referenced by gui::button::calculate_size(), gui2::image_shape::draw(), gui2::text_shape::draw(), gui::button::draw_contents(), gui::scrollbar::draw_contents(), gui::textbox::draw_contents(), font::floating_label::get_draw_size(), font::floating_label::get_pos(), gui::button::load_images(), set_draw_size(), set_draw_width(), draw::tiled(), and gui::tristate_button::tristate_button().

Member Data Documentation

◆ has_src_

bool texture::has_src_ = false

private

true iff the source rect is valid

Definition at line 214 of file texture.hpp.

Referenced by assign(), clear_src(), reset(), set_src(), set_src_raw(), and src().

◆ size_

point texture::size_ {0, 0}

private

Definition at line 213 of file texture.hpp.

Referenced by assign(), draw_size(), h(), reset(), set_draw_height(), set_draw_size(), set_draw_width(), set_src(), texture(), and w().

◆ src_

rect texture::src_

private

uninitialized by default.

Definition at line 215 of file texture.hpp.

Referenced by set_src(), set_src_raw(), and src().

◆ texture_

std::shared_ptr<SDL_Texture> texture::texture_ = nullptr

private

Definition at line 212 of file texture.hpp.

Referenced by assign(), get(), get_alpha_mod(), get_blend_mode(), get_color_mod(), operator bool(), operator SDL_Texture *(), reset(), set_alpha_mod(), set_blend_mode(), set_color_mod(), and texture().

The documentation for this class was generated from the following files:

sdl/texture.hpp
sdl/texture.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ texture() [1/4]

◆ texture() [2/4]

◆ texture() [3/4]

◆ texture() [4/4]

Member Function Documentation

◆ assign()

◆ clear_src()

◆ draw_size()

◆ finalize()

◆ get()

◆ get_access()

◆ get_alpha_mod()

◆ get_blend_mode()

◆ get_color_mod()

◆ get_format()

◆ get_info()

◆ get_raw_size()

◆ h()

◆ operator bool()

◆ operator SDL_Texture *()

◆ operator==()

◆ reset() [1/2]

◆ reset() [2/2]

◆ set_alpha_mod()

◆ set_blend_mode()

◆ set_color_mod() [1/2]

◆ set_color_mod() [2/2]

◆ set_draw_height()

◆ set_draw_size() [1/2]

◆ set_draw_size() [2/2]

◆ set_draw_width()

◆ set_src()

◆ set_src_raw()

◆ src()

◆ w()

Member Data Documentation

◆ has_src_

◆ size_

◆ src_

◆ texture_