#include "color_range.hpp"
#include "color.hpp"
#include "sdl/surface.hpp"
#include "utils/math.hpp"
#include "game_version.hpp"
#include <string>

Include dependency graph for utils.hpp:

This graph shows which files directly or indirectly include this file:

Namespaces
	sdl

Enumerations
enum	channel { RED , GREEN , BLUE , ALPHA }

Functions
version_info	sdl::get_version ()
	Returns the runtime SDL version. More...

bool	sdl::runtime_at_least (uint8_t major, uint8_t minor=0, uint8_t patch=0)
	Returns true if the runtime SDL version is at or greater than the specified version, false otherwise. More...

void	sdl_blit (const surface &src, const SDL_Rect src_rect, surface &dst, SDL_Rect dst_rect)

surface	scale_surface_xbrz (const surface &surf, std::size_t z)
	Scale a surface using xBRZ algorithm. More...

surface	scale_surface (const surface &surf, int w, int h)
	Scale a surface using alpha-weighted modified bilinear filtering Note: causes artifacts with alpha gradients, for example in some portraits. More...

surface	scale_surface_legacy (const surface &surf, int w, int h)
	Scale a surface using simple bilinear filtering (discarding rgb from source pixels with 0 alpha) More...

surface	scale_surface_sharp (const surface &surf, int w, int h)
	Scale a surface using modified nearest neighbour algorithm. More...

void	adjust_surface_color (surface &surf, int r, int g, int b)

void	greyscale_image (surface &surf)

void	monochrome_image (surface &surf, const int threshold)

void	sepia_image (surface &surf)

void	negative_image (surface &surf, const int thresholdR, const int thresholdG, const int thresholdB)

void	alpha_to_greyscale (surface &surf)

void	wipe_alpha (surface &surf)

void	shadow_image (surface &surf, int scale=1)
	create an heavy shadow of the image, by blurring, increasing alpha and darkening More...

void	swap_channels_image (surface &surf, channel r, channel g, channel b, channel a)

void	apply_surface_opacity (surface &surf, float opacity)
	Applies an opacity modification to a surface. More...

void	recolor_image (surface &surf, const color_mapping &map_rgb)
	Recolors a surface using a map with source and converted palette values. More...

void	brighten_image (surface &surf, int32_t amount)

surface	get_surface_portion (const surface &surf, rect &rect)
	Get a portion of the screen. More...

void	adjust_surface_alpha (surface &surf, uint8_t alpha_mod)

void	adjust_surface_alpha_add (surface &surf, int amount)

bool	mask_surface (surface &surf, const surface &mask, const std::string &filename=std::string())
	Applies a mask to the source surface by calculating the minimum alpha channel value for every corresponding pixel. More...

bool	in_mask_surface (const surface &surf, const surface &mask)
	Checks if the source surface is entirely covered by the visible area of the mask. More...

void	light_surface (surface &surf, const surface &lightmap)
	Light surf using lightmap. More...

void	blur_surface (surface &surf, rect rect, int depth=1)
	Cross-fades a surface in place. More...

void	blur_alpha_surface (surface &surf, int depth=1)
	Cross-fades a surface with alpha channel. More...

surface	cut_surface (const surface &surf, const rect &r)
	Cuts a rectangle from a surface. More...

void	blend_surface (surface &surf, const double amount, const color_t color)
	Blends a surface with a color. More...

surface	rotate_any_surface (const surface &surf, float angle, int zoom, int offset)
	Rotates a surface by any degrees. More...

surface	rotate_180_surface (const surface &surf)
	Rotates a surface 180 degrees. More...

surface	rotate_90_surface (const surface &surf, bool clockwise)
	Rotates a surface 90 degrees. More...

void	flip_surface (surface &surf)

void	flop_surface (surface &surf)

rect	get_non_transparent_portion (const surface &surf)

Enumeration Type Documentation

◆ channel

enum channel

Enumerator
RED
GREEN
BLUE
ALPHA

Definition at line 103 of file utils.hpp.

Function Documentation

◆ adjust_surface_alpha()

void adjust_surface_alpha	(	surface &	surf,
		uint8_t	alpha_mod
	)

Definition at line 685 of file utils.cpp.

References surf.

◆ adjust_surface_alpha_add()

void adjust_surface_alpha_add	(	surface &	surf,
		int	amount
	)

Definition at line 694 of file utils.cpp.

References b, color_t::from_argb_bytes(), g, and surface_locker< T >::pixel_span().

◆ adjust_surface_color()

void adjust_surface_color	(	surface &	surf,
		int	r,
		int	g,
		int	b
	)

Definition at line 405 of file utils.cpp.

References adjust_surface_color_simd(), b, color_t::from_argb_bytes(), g, simd::is_enabled(), surface_locker< T >::pixel_span(), and surface_helper::pixel_span().

Referenced by image::apply_light(), image::get_tod_colored(), and image::cs_modification::operator()().

◆ alpha_to_greyscale()

void alpha_to_greyscale ( surface & surf )

Definition at line 504 of file utils.cpp.

References surface_locker< T >::pixel_span().

Referenced by image::plot_alpha_modification::operator()().

◆ apply_surface_opacity()

void apply_surface_opacity	(	surface &	surf,
		float	opacity
	)

Applies an opacity modification to a surface.

Parameters

surf	The surface to modify.
opacity	The new opacity (0.0 to 1.0).

Definition at line 1392 of file utils.cpp.

References apply_surface_opacity_simd(), b, color_multiply(), float_to_color(), color_t::from_argb_bytes(), g, simd::is_enabled(), surface_locker< T >::pixel_span(), surface_helper::pixel_span(), and surf.

Referenced by image::o_modification::operator()().

◆ blend_surface()

void blend_surface	(	surface &	surf,
		const double	amount,
		const color_t	color
	)

Blends a surface with a color.

Every pixel in the surface will be blended with the color given. The final color of a pixel is amount * color + (1 - amount) * original.

Parameters

surf	The surface to blend.
amount	The amount of the new color is determined by `color`. Must be a number in the range [0, 1].
color	The color to blend width, note its alpha channel is ignored.

Definition at line 1153 of file utils.cpp.

References b, color_t::from_argb_bytes(), g, and surface_locker< T >::pixel_span().

Referenced by image::blend_modification::operator()().

◆ blur_alpha_surface()

void blur_alpha_surface	(	surface &	surf,
		int	depth = `1`
	)

Cross-fades a surface with alpha channel.

Parameters

surf	The source surface.
depth	The depth of the blurring.

Definition at line 954 of file utils.cpp.

References p, surface_locker< T >::pixels(), and surface::size().

Referenced by image::bl_modification::operator()(), and shadow_image().

◆ blur_surface()

void blur_surface	(	surface &	surf,
		rect	rect,
		int	depth = `1`
	)

Cross-fades a surface in place.

Parameters

surf	The surface to blur, must have 32 bits per pixel.
rect	The part of the surface to blur.
depth	The depth of the blurring.

Definition at line 838 of file utils.cpp.

References p, surface_locker< T >::pixels(), and surf.

Referenced by gui2::canvas::update_blur().

◆ brighten_image()

void brighten_image	(	surface &	surf,
		int32_t	amount
	)

Definition at line 667 of file utils.cpp.

References b, fixed_point_multiply(), color_t::from_argb_bytes(), g, and surface_locker< T >::pixel_span().

◆ cut_surface()

surface cut_surface	(	const surface &	surf,
		const rect &	r
	)

Cuts a rectangle from a surface.

Definition at line 1092 of file utils.cpp.

References surface_locker< T >::pixels(), PLAIN_LOG, utf8::size(), src, and surf.

Referenced by image::load_image_sub_file(), and image::crop_modification::operator()().

◆ flip_surface()

void flip_surface ( surface & surf )

Definition at line 1317 of file utils.cpp.

References flip_image_simd(), simd::is_enabled(), surface_locker< T >::pixels(), and swap().

Referenced by image::fl_modification::operator()().

◆ flop_surface()

void flop_surface ( surface & surf )

Definition at line 1340 of file utils.cpp.

References surface_locker< T >::pixels(), and swap().

Referenced by image::fl_modification::operator()().

◆ get_non_transparent_portion()

rect get_non_transparent_portion ( const surface & surf )

Definition at line 1440 of file utils.cpp.

References utils::views::stride, boost::span< T, E >::subspan(), and surf.

Referenced by BOOST_AUTO_TEST_CASE(), and image::crop_transparency_modification::operator()().

◆ get_surface_portion()

surface get_surface_portion	(	const surface &	surf,
		rect &	rect
	)

Get a portion of the screen.

Send nullptr if the portion is outside of the screen.

Parameters

surf	The source surface.
rect	The portion of the source surface to copy.

Returns: A surface containing the portion of the source. No RLE or Alpha bits are set.

Return values

0	if error or the portion is outside of the surface.

Definition at line 1356 of file utils.cpp.

References dst, PLAIN_LOG, and src.

Referenced by image::crop_transparency_modification::operator()().

◆ greyscale_image()

void greyscale_image ( surface & surf )

Definition at line 424 of file utils.cpp.

References b, color_t::from_argb_bytes(), g, and surface_locker< T >::pixel_span().

Referenced by image::gs_modification::operator()().

◆ in_mask_surface()

bool in_mask_surface	(	const surface &	surf,
		const surface &	mask
	)

Checks if the source surface is entirely covered by the visible area of the mask.

If a visible pixel is found outside the mask's visible area, the function immediately returns false. Mostly used to see if an image has all visable pixels within a hex shape.

Parameters

surf	The source surface (whose visibility is being checked).
mask	The mask surface (whose visible area defines the boundary).

Returns: true if all visible pixels of surf are contained within the non-transparent area of mask (i.e., the surface is fully covered). Returns false otherwise.

Definition at line 756 of file utils.cpp.

References i, surface_locker< T >::pixel_span(), SDL_ALPHA_MASK, and boost::span< T, E >::size().

Referenced by image::is_in_hex().

◆ light_surface()

void light_surface	(	surface &	surf,
		const surface &	lightmap
	)

Light surf using lightmap.

Parameters

surf	The source surface.
lightmap	add/subtract this color to surf but RGB values are converted to (X-128)*2 to cover the full (-256,256) spectrum. Should already be neutral

Definition at line 790 of file utils.cpp.

References surface::area(), b, color_t::from_argb_bytes(), g, surface_locker< T >::pixels(), and PLAIN_LOG.

Referenced by image::apply_light(), and image::light_modification::operator()().

◆ mask_surface()

bool mask_surface	(	surface &	surf,
		const surface &	mask,
		const std::string &	filename = `std::string()`
	)

Applies a mask to the source surface by calculating the minimum alpha channel value for every corresponding pixel.

This operation ensures that the resulting surface is only visible where BOTH the original surface AND the mask were visible. Mostly used to remove any pixels outside a hex shape.

Parameters

surf	The surface to be modified (the destination).
mask	The mask surface (read-only). if the resulting surface contains no visible pixels (i.e., is fully transparent).
filename	Optional string for logging purposes.

Definition at line 708 of file utils.cpp.

References filename, i, simd::is_enabled(), mask_surface_simd(), surface_locker< T >::pixel_span(), PLAIN_LOG, SDL_ALPHA_MASK, boost::span< T, E >::size(), and boost::span< T, E >::subspan().

Referenced by image::get_hexed(), image::is_empty_hex(), image::load_image_sub_file(), and image::mask_modification::operator()().

◆ monochrome_image()

void monochrome_image	(	surface &	surf,
		const int	threshold
	)

Definition at line 446 of file utils.cpp.

References b, color_t::from_argb_bytes(), g, and surface_locker< T >::pixel_span().

Referenced by image::bw_modification::operator()().

◆ negative_image()

void negative_image	(	surface &	surf,
		const int	thresholdR,
		const int	thresholdG,
		const int	thresholdB
	)

Definition at line 483 of file utils.cpp.

References b, color_t::from_argb_bytes(), g, and surface_locker< T >::pixel_span().

Referenced by image::negative_modification::operator()().

◆ recolor_image()

void recolor_image	(	surface &	surf,
		const color_mapping &	map_rgb
	)

Recolors a surface using a map with source and converted palette values.

This is most often used for team-coloring.

Parameters

surf	The source surface.
map_rgb	Map of color values, with the keys corresponding to the source palette, and the values to the recolored palette.

Definition at line 636 of file utils.cpp.

References ALPHA_OPAQUE, color_t::from_argb_bytes(), and surface_locker< T >::pixel_span().

Referenced by image::rc_modification::operator()().

◆ rotate_180_surface()

surface rotate_180_surface ( const surface & surf )

Rotates a surface 180 degrees.

Parameters

surf	The surface to rotate.

Returns: The rotated surface.

Definition at line 1243 of file utils.cpp.

References surface::clone(), is_odd(), surface_locker< T >::pixels(), PLAIN_LOG, surf, and swap().

Referenced by image::fl_modification::operator()(), and image::rotate_modification::operator()().

◆ rotate_90_surface()

surface rotate_90_surface	(	const surface &	surf,
		bool	clockwise
	)

Rotates a surface 90 degrees.

Parameters

surf	The surface to rotate.
clockwise	Whether the rotation should be clockwise (true) or counter-clockwise (false).

Returns: The rotated surface.

Definition at line 1283 of file utils.cpp.

References dst, surface_locker< T >::pixels(), PLAIN_LOG, and surf.

Referenced by image::rotate_modification::operator()().

◆ rotate_any_surface()

surface rotate_any_surface	(	const surface &	surf,
		float	angle,
		int	zoom,
		int	offset
	)

Rotates a surface by any degrees.

Precondition: zoom >= offset Otherwise

Returns: will have empty pixels.

Precondition: offset > 0 Otherwise the procedure will not return.

Parameters

surf	The surface to rotate.
angle	The angle of rotation.
zoom	Which zoom level to use for calculating the result.
offset	Pixel offset when scanning the zoomed source.

Returns: The rotated surface.

Definition at line 1181 of file utils.cpp.

References dst, surface_locker< T >::pixels(), xbrz::scale(), scale_surface(), src, and surf.

Referenced by image::rotate_modification::operator()().

◆ scale_surface()

surface scale_surface	(	const surface &	surf,
		int	w,
		int	h
	)

Scale a surface using alpha-weighted modified bilinear filtering Note: causes artifacts with alpha gradients, for example in some portraits.

Parameters

surf	The source surface.
w	The width of the resulting surface.
h	The height of the resulting surface.

Returns: A surface containing the scaled version of the source.

Return values

0	Returned upon error.
surf	Returned if w == surf->w and h == surf->h.

Definition at line 99 of file utils.cpp.

References b, dst, e, fixed_point_divide(), fixed_point_to_int(), g, h, loc, n, surface_locker< T >::pixels(), PLAIN_LOG, s, surf, and w.

Referenced by image::light_modification::operator()(), video::read_pixels_low_res(), and rotate_any_surface().

◆ scale_surface_legacy()

surface scale_surface_legacy	(	const surface &	surf,
		int	w,
		int	h
	)

Scale a surface using simple bilinear filtering (discarding rgb from source pixels with 0 alpha)

Parameters

surf	The source surface.
w	The width of the resulting surface.
h	The height of the resulting surface.

Returns: A surface containing the scaled version of the source.

Return values

0	Returned upon error.
surf	Returned if w == surf->w and h == surf->h.

Definition at line 225 of file utils.cpp.

References b, dst, fixed_point_divide(), fixed_point_to_int(), g, h, loc, surface_locker< T >::pixels(), PLAIN_LOG, surf, and w.

Referenced by image::scale_modification::operator()().

◆ scale_surface_sharp()

surface scale_surface_sharp	(	const surface &	surf,
		int	w,
		int	h
	)

Scale a surface using modified nearest neighbour algorithm.

Use only if preserving sharp edges is a priority (e.g. minimap).

Parameters

surf	The source surface.
w	The width of the resulting surface.
h	The height of the resulting surface.

Returns: A surface containing the scaled version of the source.

Return values

0	Returned upon error.
surf	Returned if w == surf->w and h == surf->h.

Definition at line 358 of file utils.cpp.

References dst, h, surface_locker< T >::pixels(), PLAIN_LOG, surf, and w.

Referenced by BOOST_AUTO_TEST_CASE(), and image::scale_modification::operator()().

◆ scale_surface_xbrz()

surface scale_surface_xbrz	(	const surface &	surf,
		std::size_t	z
	)

Scale a surface using xBRZ algorithm.

Parameters

surf	The source surface
z	The scaling factor. Should be an integer 2-5 (1 is tolerated).

Returns: The scaled surface

Definition at line 61 of file utils.cpp.

References xbrz::ARGB, dst, surface_locker< T >::pixels(), PLAIN_LOG, xbrz::scale(), xbrz::SCALE_FACTOR_MAX, and surf.

Referenced by image::xbrz_modification::operator()().

◆ sdl_blit()

void sdl_blit	(	const surface &	src,
		const SDL_Rect *	src_rect,
		surface &	dst,
		SDL_Rect *	dst_rect
	)

inline

Definition at line 43 of file utils.hpp.

References dst, and src.

Referenced by image::add_localized_overlay(), image::apply_light(), image::get_hexed(), image::blit_modification::operator()(), image::mask_modification::operator()(), and image::background_modification::operator()().

◆ sepia_image()

void sepia_image ( surface & surf )

Definition at line 464 of file utils.cpp.

References b, color_t::from_argb_bytes(), g, and surface_locker< T >::pixel_span().

Referenced by image::sepia_modification::operator()().

◆ shadow_image()

void shadow_image	(	surface &	surf,
		int	scale = `1`
	)

create an heavy shadow of the image, by blurring, increasing alpha and darkening

Definition at line 529 of file utils.cpp.

References blur_alpha_surface(), surface_locker< T >::pixel_span(), xbrz::scale(), and surf.

◆ swap_channels_image()

void swap_channels_image	(	surface &	surf,
		channel	r,
		channel	g,
		channel	b,
		channel	a
	)

Definition at line 554 of file utils.cpp.

References ALPHA, b, BLUE, color_t::from_argb_bytes(), g, GREEN, surface_locker< T >::pixel_span(), and RED.

Referenced by image::swap_modification::operator()().

◆ wipe_alpha()

void wipe_alpha ( surface & surf )

Definition at line 517 of file utils.cpp.

References surface_locker< T >::pixel_span().

Referenced by image::wipe_alpha_modification::operator()().

Namespaces

Enumerations

Functions

Enumeration Type Documentation

◆ channel

Function Documentation

◆ adjust_surface_alpha()

◆ adjust_surface_alpha_add()

◆ adjust_surface_color()

◆ alpha_to_greyscale()

◆ apply_surface_opacity()

◆ blend_surface()

◆ blur_alpha_surface()

◆ blur_surface()

◆ brighten_image()

◆ cut_surface()

◆ flip_surface()

◆ flop_surface()

◆ get_non_transparent_portion()

◆ get_surface_portion()

◆ greyscale_image()

◆ in_mask_surface()

◆ light_surface()

◆ mask_surface()

◆ monochrome_image()

◆ negative_image()

◆ recolor_image()

◆ rotate_180_surface()

◆ rotate_90_surface()

◆ rotate_any_surface()

◆ scale_surface()

◆ scale_surface_legacy()

◆ scale_surface_sharp()

◆ scale_surface_xbrz()

◆ sdl_blit()

◆ sepia_image()

◆ shadow_image()

◆ swap_channels_image()

◆ wipe_alpha()