FrameBufferResizeEvent Class

Event representing a change in the framebuffer's size. More...

Declaration

class helios::window::event::FrameBufferResizeEvent { ... }

Base class

class	WindowEvent
	Abstract base class for Window related events. More...

Public Constructors Index

	FrameBufferResizeEvent (util::Guid sourceGuid, int width, int height) noexcept
	Constructs a `FrameBufferResizeEvent`. More...
	FrameBufferResizeEvent (util::Guid sourceGuid, int width, int height, uint64_t tag) noexcept
	Constructs a `FrameBufferResizeEvent`. More...

Public Member Functions Index

std::string	toString () const noexcept override

Public Member Attributes Index

const int	width
	The width of the framebuffer in pixels. More...
const int	height
	The height of the framebuffer in pixels. More...

Description

Event representing a change in the framebuffer's size.

The event should be triggered whenever a change in the underlying framebuffer of a window is detected, indicating that the rendering context (e.g. OpenGL) might need adjustments. FramebufferResizeEvents carry the width and the height of the framebuffer.

Definition at line 29 of file FrameBufferResizeEvent.ixx.

Public Constructors

FrameBufferResizeEvent()

helios::window::event::FrameBufferResizeEvent::FrameBufferResizeEvent (util::Guid sourceGuid, int width, int height)

inline noexcept

Constructs a `FrameBufferResizeEvent`.

Parameters

sourceGuid	The Guid of the source of the event.
width	The new width of the framebuffer.
height	The new height of the framebuffer.

Definition at line 51 of file FrameBufferResizeEvent.ixx.

51 FrameBufferResizeEvent(

52 util::Guid sourceGuid, int width, int height

53 ) noexcept :

54 WindowEvent(sourceGuid),

55 width(width),

56 height(height)

57 {}

References height, helios::window::event::WindowEvent::sourceGuid and width.

FrameBufferResizeEvent()

helios::window::event::FrameBufferResizeEvent::FrameBufferResizeEvent (util::Guid sourceGuid, int width, int height, uint64_t tag)

inline noexcept

Constructs a `FrameBufferResizeEvent`.

Parameters

sourceGuid	The Guid of the source of the event.
width	The new width of the framebuffer.
height	The new height of the framebuffer.
tag	A `uint64_t` tag for identifying/categorizing the event.

Definition at line 68 of file FrameBufferResizeEvent.ixx.

68 FrameBufferResizeEvent(

69 util::Guid sourceGuid,

70 int width, int height, uint64_t tag

71 ) noexcept :

72 WindowEvent(sourceGuid, tag),

73 width(width),

74 height(height)

75 {}

References height, helios::window::event::WindowEvent::sourceGuid, helios::event::Event::tag and width.

Public Member Functions

toString()

std::string helios::window::event::FrameBufferResizeEvent::toString ()

inline noexcept virtual

Definition at line 78 of file FrameBufferResizeEvent.ixx.

78 std::string toString() const noexcept override {

79 return std::format(

80 "FrameBufferResizeEvent[{0}, {1}, {2}, {3}]",

81 sourceGuid.value(),

82 tag(),

83 width,

84 height

85 );

86 }

References height, helios::window::event::WindowEvent::sourceGuid, helios::event::Event::tag and width.

Public Member Attributes

height

const int helios::window::event::FrameBufferResizeEvent::height

The height of the framebuffer in pixels.

Definition at line 41 of file FrameBufferResizeEvent.ixx.

41 const int height;

Referenced by FrameBufferResizeEvent, FrameBufferResizeEvent, helios::app::controller::BasicWindowRenderingController::onFrameBufferResize and toString.

width

const int helios::window::event::FrameBufferResizeEvent::width

The width of the framebuffer in pixels.

Definition at line 35 of file FrameBufferResizeEvent.ixx.

35 const int width;

Referenced by FrameBufferResizeEvent, FrameBufferResizeEvent, helios::app::controller::BasicWindowRenderingController::onFrameBufferResize and toString.

---

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

• FrameBufferResizeEvent.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.