User interface layer: UI components, rendering, and interaction handling. More...

Classes
class	Raven::UI::ScopedStyle
	RAII helper to push and pop a single ImGui style variable. Pushes the style var on construction, pops on destruction. More...
class	Raven::UI::ScopedColor
	RAII helper to push and pop a single ImGui style color. More...
class	Raven::UI::ScopedFont
	RAII helper to push and pop an ImGui font. More...
class	Raven::UI::ScopedID
	RAII helper to push and pop an ImGui ID. Supports any type convertible to ImGuiID. More...
class	Raven::UI::ScopedColorStack
	RAII helper to push and pop multiple ImGui style colors in one go. Expects a list of pairs: (ImGuiCol colorID, ColorValue). More...
class	Raven::UI::ScopedStyleStack
	RAII helper to push and pop multiple ImGui style variables in one go. Expects a list of pairs: (ImGuiStyleVar, Value). More...
class	Raven::UI::ScopedItemFlags
	RAII helper to push and pop ImGui item flags. More...
struct	Raven::UI::Toast
	Simple structure to represent a toast notification. More...

Functions
ImVec4	Raven::Colors::ConvertFromSRGB (ImVec4 colour)
	Converts an sRGB ImVec4 color to linear space.
ImVec4	Raven::Colors::ConvertToSRGB (ImVec4 colour)
	Converts a linear ImVec4 color to sRGB space.
ImU32	Raven::Colors::ColorWithValue (const ImColor &color, float value)
	Modifies the V (value) of a color in HSV space.
ImU32	Raven::Colors::ColorWithSaturation (const ImColor &color, float saturation)
	Modifies the S (saturation) of a color in HSV space.
ImU32	Raven::Colors::ColorWithHue (const ImColor &color, float hue)
	Modifies the H (hue) of a color in HSV space.
ImU32	Raven::Colors::ColorWithMultipliedValue (const ImColor &color, float multiplier)
	Scales the V (value) of a color in HSV space.
ImU32	Raven::Colors::ColorWithMultipliedSaturation (const ImColor &color, float multiplier)
	Scales the S (saturation) of a color in HSV space.
ImU32	Raven::Colors::ColorWithMultipliedHue (const ImColor &color, float multiplier)
	Scales the H (hue) of a color in HSV space.
void	Raven::UI::Image (Ref< Image2D > image, float width, float height)
	Render an Image2D at the specified size.
bool	Raven::UI::CreateCombo (const char *label, std::string &currentItem, std::vector< std::string > &items, ImGuiComboFlags_ flags)
	Create a combo box widget with a list of string items.
void	Raven::UI::SuspendLayout ()
	Suspend layout updates for batching UI changes.
void	Raven::UI::ResumeLayout ()
	Resume layout updates after suspension.
void	Raven::UI::ShiftCursorX (float distance)
	Shift the ImGui cursor horizontally.
void	Raven::UI::ShiftCursorY (float distance)
	Shift the ImGui cursor vertically.
void	Raven::UI::ShiftCursor (float x, float y)
	Shift the ImGui cursor position by a 2D offset.
ImRect	Raven::UI::GetItemRect ()
	Retrieve the rectangle of the last rendered ImGui item.
ImRect	Raven::UI::RectExpanded (const ImRect &rect, float x, float y)
	Expand an ImRect by a fixed pixel amount on each axis.
ImRect	Raven::UI::RectOffset (const ImRect &rect, float x, float y)
	Offset an ImRect by fixed pixel amounts.
ImRect	Raven::UI::RectOffset (const ImRect &rect, ImVec2 xy)
	Offset an ImRect by a 2D vector.
void	Raven::UI::DrawVec2Control (const std::string &label, Crux::vec2 &values, float resetValue=0.0f, float columnLabelWidth=50.0f)
	Draw a labeled UI control for editing a 2D vector.
void	Raven::UI::DrawVec3Control (const std::string &label, Crux::vec3 &values, float resetValue=0.0f, float columnLabelWidth=50.0f)
	Draw a labeled UI control for editing a 3D vector.
void	Raven::UI::RenderWindowOuterBorders (ImGuiWindow *window)
	Render borders around the outer edge of a window.
bool	Raven::UI::UpdateWindowManualResize (ImGuiWindow *window, ImVec2 &newSize, ImVec2 &newPosition)
	Handle manual window resize operation.
void	Raven::UI::BeginHorizontal (const char *str_id=nullptr, const ImVec2 &size=ImVec2(0, 0))
	Begin a horizontal UI layout group.
void	Raven::UI::EndHorizontal ()
	End the current horizontal layout group.
void	Raven::UI::BeginVertical (const char *str_id=nullptr, const ImVec2 &size=ImVec2(0, 0))
	Begin a vertical UI layout group.
void	Raven::UI::EndVertical ()
	End the current vertical layout group.
bool	Raven::UI::SelectableW (const wchar_t *label, bool selected, ImGuiSelectableFlags flags=0)
	Render a selectable item using a wide-character label.
void	Raven::UI::Spring (float weightX=1.0f, float weightY=1.0f)
	Insert flexible spacing using weights.
bool	Raven::UI::BeginMenubar (const ImRect &barRectangle)
	Begin a custom menubar inside a defined rectangle.
void	Raven::UI::EndMenubar ()
	End the current menubar.
void	Raven::UI::DrawBorder (ImRect rect, float thickness=1.0f, float rounding=0.0f, float offsetX=0.0f, float offsetY=0.0f)
	Draws a border around a given ImRect area.
void	Raven::UI::ShowToast (const std::string &message, float duration, ImVec4 color=ImVec4(1.0f, 1.0f, 1.0f, 1.0f))
	Display a toast notification.
void	Raven::UI::RenderToasts (const ImVec2 &viewportPos, const ImVec2 &viewportSize)
	Render all active toasts within the given viewport area.

Detailed Description

User interface layer: UI components, rendering, and interaction handling.

Function Documentation

◆ BeginHorizontal()

FRAMEWORK_API void Raven::UI::BeginHorizontal	(	const char *	str_id = nullptr,
		const ImVec2 &	size = ImVec2(0, 0) )

Begin a horizontal UI layout group.

Parameters

str_id	Optional ID to distinguish multiple horizontal layouts.
size	Optional size override.

◆ BeginMenubar()

FRAMEWORK_API bool Raven::UI::BeginMenubar ( const ImRect & barRectangle )

Begin a custom menubar inside a defined rectangle.

Parameters

barRectangle Bounding rectangle of the menubar.

Returns: true if the menubar was successfully started.

◆ BeginVertical()

FRAMEWORK_API void Raven::UI::BeginVertical	(	const char *	str_id = nullptr,
		const ImVec2 &	size = ImVec2(0, 0) )

Begin a vertical UI layout group.

Parameters

str_id	Optional ID to distinguish multiple vertical layouts.
size	Optional size override.

◆ ColorWithHue()

ImU32 Raven::Colors::ColorWithHue	(	const ImColor &	color,
		float	hue )

inline

Modifies the H (hue) of a color in HSV space.

Parameters

color	Source ImColor.
hue	New hue in [0.0, 1.0].

Returns: ImU32 with adjusted hue.

◆ ColorWithMultipliedHue()

ImU32 Raven::Colors::ColorWithMultipliedHue	(	const ImColor &	color,
		float	multiplier )

inline

Scales the H (hue) of a color in HSV space.

Parameters

color	Source ImColor.
multiplier	Hue multiplier.

Returns: ImU32 with scaled hue.

◆ ColorWithMultipliedSaturation()

ImU32 Raven::Colors::ColorWithMultipliedSaturation	(	const ImColor &	color,
		float	multiplier )

inline

Scales the S (saturation) of a color in HSV space.

Parameters

color	Source ImColor.
multiplier	Saturation multiplier.

Returns: ImU32 with scaled saturation.

◆ ColorWithMultipliedValue()

ImU32 Raven::Colors::ColorWithMultipliedValue	(	const ImColor &	color,
		float	multiplier )

inline

Scales the V (value) of a color in HSV space.

Parameters

color	Source ImColor.
multiplier	Value multiplier.

Returns: ImU32 with scaled value.

◆ ColorWithSaturation()

ImU32 Raven::Colors::ColorWithSaturation	(	const ImColor &	color,
		float	saturation )

inline

Modifies the S (saturation) of a color in HSV space.

Parameters

color	Source ImColor.
saturation	New saturation in [0.0, 1.0].

Returns: ImU32 with adjusted saturation.

◆ ColorWithValue()

ImU32 Raven::Colors::ColorWithValue	(	const ImColor &	color,
		float	value )

inline

Modifies the V (value) of a color in HSV space.

Parameters

color	Source ImColor.
value	New value in [0.0, 1.0].

Returns: ImU32 with adjusted value.

◆ ConvertFromSRGB()

ImVec4 Raven::Colors::ConvertFromSRGB ( ImVec4 colour )

inline

Converts an sRGB ImVec4 color to linear space.

Parameters

colour sRGB color.

Returns: Linear color.

◆ ConvertToSRGB()

ImVec4 Raven::Colors::ConvertToSRGB ( ImVec4 colour )

inline

Converts a linear ImVec4 color to sRGB space.

Parameters

colour Linear color.

Returns: sRGB color.

◆ CreateCombo()

FRAMEWORK_API bool Raven::UI::CreateCombo	(	const char *	label,
		std::string &	currentItem,
		std::vector< std::string > &	items,
		ImGuiComboFlags_	flags )

Create a combo box widget with a list of string items.

Parameters

label	Label displayed next to the combo box.
currentItem	Reference to the string holding the currently selected item. Will be updated if the user selects a different item.
items	Vector of strings to populate the combo box options.
flags	Optional ImGui combo box behavior flags.

Returns: true if the selected item was changed.

◆ DrawBorder()

FRAMEWORK_API void Raven::UI::DrawBorder	(	ImRect	rect,
		float	thickness = 1.0f,
		float	rounding = 0.0f,
		float	offsetX = 0.0f,
		float	offsetY = 0.0f )

Draws a border around a given ImRect area.

Parameters

rect	Rectangle specifying the border area.
thickness	Thickness of the border line.
rounding	Corner rounding radius.
offsetX	Horizontal offset for the border.
offsetY	Vertical offset for the border.

◆ DrawVec2Control()

FRAMEWORK_API void Raven::UI::DrawVec2Control	(	const std::string &	label,
		Crux::vec2 &	values,
		float	resetValue = 0.0f,
		float	columnLabelWidth = 50.0f )

Draw a labeled UI control for editing a 2D vector.

Parameters

label	Name of the control displayed to the left.
values	Reference to Crux::vec2 variable to modify.
resetValue	Default value used when reset button is clicked.
columnLabelWidth	Width of the label column in pixels.

◆ DrawVec3Control()

FRAMEWORK_API void Raven::UI::DrawVec3Control	(	const std::string &	label,
		Crux::vec3 &	values,
		float	resetValue = 0.0f,
		float	columnLabelWidth = 50.0f )

Draw a labeled UI control for editing a 3D vector.

Parameters

label	Name of the control displayed to the left.
values	Reference to Crux::vec3 variable to modify.
resetValue	Default value used when reset button is clicked.
columnLabelWidth	Width of the label column in pixels.

◆ EndHorizontal()

FRAMEWORK_API void Raven::UI::EndHorizontal ( )

End the current horizontal layout group.

◆ EndMenubar()

FRAMEWORK_API void Raven::UI::EndMenubar ( )

End the current menubar.

◆ EndVertical()

FRAMEWORK_API void Raven::UI::EndVertical ( )

End the current vertical layout group.

◆ GetItemRect()

FRAMEWORK_API ImRect Raven::UI::GetItemRect ( )

Retrieve the rectangle of the last rendered ImGui item.

Returns: Bounding rectangle of the last item.

◆ Image()

FRAMEWORK_API void Raven::UI::Image	(	Ref< Image2D >	image,
		float	width,
		float	height )

Render an Image2D at the specified size.

Parameters

image	Reference-counted Image2D resource to render.
width	Desired image width in pixels.
height	Desired image height in pixels.

◆ RectExpanded()

FRAMEWORK_API ImRect Raven::UI::RectExpanded	(	const ImRect &	rect,
		float	x,
		float	y )

Expand an ImRect by a fixed pixel amount on each axis.

Parameters

rect	Rectangle to expand.
x	Amount to expand on left/right sides.
y	Amount to expand on top/bottom sides.

Returns: Expanded rectangle.

◆ RectOffset() [1/2]

FRAMEWORK_API ImRect Raven::UI::RectOffset	(	const ImRect &	rect,
		float	x,
		float	y )

Offset an ImRect by fixed pixel amounts.

Parameters

rect	Rectangle to offset.
x	Horizontal offset.
y	Vertical offset.

Returns: Offset rectangle.

◆ RectOffset() [2/2]

FRAMEWORK_API ImRect Raven::UI::RectOffset	(	const ImRect &	rect,
		ImVec2	xy )

Offset an ImRect by a 2D vector.

Parameters

rect	Rectangle to offset.
xy	ImVec2 offset to apply.

Returns: Offset rectangle.

◆ RenderToasts()

FRAMEWORK_API void Raven::UI::RenderToasts	(	const ImVec2 &	viewportPos,
		const ImVec2 &	viewportSize )

Render all active toasts within the given viewport area.

Parameters

viewportPos	Position of the viewport (top-left corner).
viewportSize	Size of the viewport.

◆ RenderWindowOuterBorders()

FRAMEWORK_API void Raven::UI::RenderWindowOuterBorders ( ImGuiWindow * window )

Render borders around the outer edge of a window.

Parameters

window Pointer to the ImGui window to render borders for.

◆ ResumeLayout()

FRAMEWORK_API void Raven::UI::ResumeLayout ( )

Resume layout updates after suspension.

◆ SelectableW()

FRAMEWORK_API bool Raven::UI::SelectableW	(	const wchar_t *	label,
		bool	selected,
		ImGuiSelectableFlags	flags = 0 )

Render a selectable item using a wide-character label.

Parameters

label	Wide character string label.
selected	Whether the item is currently selected.
flags	ImGui selectable flags.

Returns: true if the item was clicked.

◆ ShiftCursor()

FRAMEWORK_API void Raven::UI::ShiftCursor	(	float	x,
		float	y )

Shift the ImGui cursor position by a 2D offset.

Parameters

x	Horizontal shift in pixels.
y	Vertical shift in pixels.

◆ ShiftCursorX()

FRAMEWORK_API void Raven::UI::ShiftCursorX ( float distance )

Shift the ImGui cursor horizontally.

Parameters

distance Distance in pixels to shift along the X axis.

◆ ShiftCursorY()

FRAMEWORK_API void Raven::UI::ShiftCursorY ( float distance )

Shift the ImGui cursor vertically.

Parameters

distance Distance in pixels to shift along the Y axis.

◆ ShowToast()

FRAMEWORK_API void Raven::UI::ShowToast	(	const std::string &	message,
		float	duration,
		ImVec4	color = ImVec4(1.0f, 1.0f, 1.0f, 1.0f) )

Display a toast notification.

Parameters

message	The message string to display.
duration	Duration in seconds the toast remains visible.
color	Color of the toast text (default white).

◆ Spring()

FRAMEWORK_API void Raven::UI::Spring	(	float	weightX = 1.0f,
		float	weightY = 1.0f )

Insert flexible spacing using weights.

Parameters

weightX	Horizontal spring weight.
weightY	Vertical spring weight.

◆ SuspendLayout()

FRAMEWORK_API void Raven::UI::SuspendLayout ( )

Suspend layout updates for batching UI changes.

◆ UpdateWindowManualResize()

FRAMEWORK_API bool Raven::UI::UpdateWindowManualResize	(	ImGuiWindow *	window,
		ImVec2 &	newSize,
		ImVec2 &	newPosition )

Handle manual window resize operation.

Parameters

window	Target ImGui window.
newSize	Output: new size if resized.
newPosition	Output: new position if resized.

Returns: true if resizing occurred.

	Raven Engine v0.1 A modern 3D Game Engine

Classes

Functions

Detailed Description

Function Documentation

◆ BeginHorizontal()

◆ BeginMenubar()

◆ BeginVertical()

◆ ColorWithHue()

◆ ColorWithMultipliedHue()

◆ ColorWithMultipliedSaturation()

◆ ColorWithMultipliedValue()

◆ ColorWithSaturation()

◆ ColorWithValue()

◆ ConvertFromSRGB()

◆ ConvertToSRGB()

◆ CreateCombo()

◆ DrawBorder()

◆ DrawVec2Control()

◆ DrawVec3Control()

◆ EndHorizontal()

◆ EndMenubar()

◆ EndVertical()

◆ GetItemRect()

◆ Image()

◆ RectExpanded()

◆ RectOffset() [1/2]

◆ RectOffset() [2/2]

◆ RenderToasts()

◆ RenderWindowOuterBorders()

◆ ResumeLayout()

◆ SelectableW()

◆ ShiftCursor()

◆ ShiftCursorX()

◆ ShiftCursorY()

◆ ShowToast()

◆ Spring()

◆ SuspendLayout()

◆ UpdateWindowManualResize()