surface_locker< T > Class Template Reference

Helper class for pinning SDL surfaces into memory. More...

#include <surface.hpp>

Public Member Functions
	surface_locker (T &surf)
	~surface_locker ()
pixel_t *	pixels () const
utils::span< pixel_t >	pixel_span () const

Private Types
using	pixel_t = utils::const_clone_t< uint32_t, T >

Private Attributes
T &	surface_
bool	locked_

Detailed Description

template<typename T>
class surface_locker< T >

Helper class for pinning SDL surfaces into memory.

Note

This class should be used only with neutral surfaces, so that the pointer returned by pixels is meaningful.

Definition at line 70 of file surface.hpp.

Member Typedef Documentation

pixel_t

template<typename T >

using surface_locker< T >::pixel_t = utils::const_clone_t<uint32_t, T>

private

Definition at line 73 of file surface.hpp.

Constructor & Destructor Documentation

surface_locker()

template<typename T >

surface_locker< T >::surface_locker ( T &  surf )

inline

Definition at line 76 of file surface.hpp.

References surface_locker< T >::locked_, and surface_locker< T >::surface_.

~surface_locker()

template<typename T >

surface_locker< T >::~surface_locker ( )

inline

Definition at line 83 of file surface.hpp.

References surface_locker< T >::locked_, and surface_locker< T >::surface_.

Member Function Documentation

pixel_span()

template<typename T >

utils::span<pixel_t> surface_locker< T >::pixel_span ( ) const

inline

Definition at line 95 of file surface.hpp.

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

Referenced by adjust_surface_alpha_add(), adjust_surface_color(), alpha_to_greyscale(), blend_surface(), brighten_image(), greyscale_image(), monochrome_image(), negative_image(), image::adjust_alpha_modification::operator()(), image::adjust_channels_modification::operator()(), recolor_image(), sepia_image(), shadow_image(), swap_channels_image(), and wipe_alpha().

pixels()

template<typename T >

pixel_t* surface_locker< T >::pixels ( ) const

inline

Definition at line 90 of file surface.hpp.

References surface_locker< T >::surface_.

Referenced by blur_alpha_surface(), blur_surface(), cut_surface(), flip_surface(), flop_surface(), get_non_transparent_portion(), in_mask_surface(), light_surface(), mask_surface(), image::o_modification::operator()(), surface_locker< T >::pixel_span(), rotate_180_surface(), rotate_90_surface(), rotate_any_surface(), scale_surface(), scale_surface_legacy(), scale_surface_sharp(), and scale_surface_xbrz().

Member Data Documentation

locked_

template<typename T >

bool surface_locker< T >::locked_

private

Definition at line 102 of file surface.hpp.

Referenced by surface_locker< T >::surface_locker(), and surface_locker< T >::~surface_locker().

surface_

template<typename T >

T& surface_locker< T >::surface_

private

Definition at line 101 of file surface.hpp.

Referenced by surface_locker< T >::pixel_span(), surface_locker< T >::pixels(), surface_locker< T >::surface_locker(), and surface_locker< T >::~surface_locker().

---

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

• sdl/surface.hpp