tachyon::LayeredFades Class Reference

Layered windows that stand in for a window while it fades in or out: each shows a fixed picture (the window's last frame) at a screen rect and an opacity. More...

#include <gui_core/windows/gui_layered_fade.h>

Public Member Functions
	LayeredFades ()
	~LayeredFades ()
	LayeredFades (const LayeredFades &)=delete
LayeredFades &	operator= (const LayeredFades &)=delete
uint32_t	Show (std::span< const uint8_t > bgra, int2 size, IntRect screenRect, float opacity)
	Shows bgra (size pixels, BGRA8, alpha 255 for an opaque window) at screenRect (screen pixels; the picture is drawn at its own size from its top-left) with opacity (0 to 1).
void	Move (uint32_t fade, IntRect screenRect, float opacity)
	Moves a stand-in and sets its opacity.
void	End (uint32_t fade)
	Removes a stand-in; 0 and unknown ones are ignored.
size_t	Count () const
	How many are shown.

Detailed Description

Layered windows that stand in for a window while it fades in or out: each shows a fixed picture (the window's last frame) at a screen rect and an opacity.

A window with a GPU surface can't be faded itself on Windows, where a fading window needs to be layered. Elsewhere there are none: Show returns 0.

Constructor & Destructor Documentation

LayeredFades() [1/2]

tachyon::LayeredFades::LayeredFades

(

)

~LayeredFades()

tachyon::LayeredFades::~LayeredFades

(

)

LayeredFades() [2/2]

tachyon::LayeredFades::LayeredFades ( const LayeredFades & )

delete

Member Function Documentation

operator=()

LayeredFades & tachyon::LayeredFades::operator= ( const LayeredFades & )

delete

Show()

uint32_t tachyon::LayeredFades::Show	(	std::span< const uint8_t >	bgra,
		int2	size,
		IntRect	screenRect,
		float	opacity )

Shows bgra (size pixels, BGRA8, alpha 255 for an opaque window) at screenRect (screen pixels; the picture is drawn at its own size from its top-left) with opacity (0 to 1).

Returns the stand-in, or 0 when it can't be shown.

Move()

void tachyon::LayeredFades::Move	(	uint32_t	fade,
		IntRect	screenRect,
		float	opacity )

Moves a stand-in and sets its opacity.

End()

void tachyon::LayeredFades::End

(

uint32_t

fade

)

Removes a stand-in; 0 and unknown ones are ignored.

Count()

size_t tachyon::LayeredFades::Count

(

)

const

How many are shown.

---

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

• gui_core/windows/gui_layered_fade.h