Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzFramework::TextDrawParameters Struct Reference

Standard parameters for drawing text on screen. More...

#include <FontInterface.h>

Public Attributes

ViewportId m_drawViewportId = InvalidViewportId
 Viewport to draw into.
 
AZ::Vector3 m_position
 world space position for 3d draws, screen space x,y,depth for 2d.
 
AZ::Color m_color = AZ::Colors::White
 Color to draw the text.
 
unsigned int m_effectIndex = 0
 effect index to apply
 
AZ::Vector2 m_scale = AZ::Vector2(1.0f)
 font scale
 
float m_textSizeFactor = 12.0f
 font size in pixels
 
float m_lineSpacing = 1.0f
 Spacing between new lines, as a percentage of m_scale.
 
TextHorizontalAlignment m_hAlign = TextHorizontalAlignment::Left
 Horizontal text alignment.
 
TextVerticalAlignment m_vAlign = TextVerticalAlignment::Top
 Vertical text alignment.
 
bool m_useTransform = false
 Use specified transform.
 
AZ::Matrix3x4 m_transform = AZ::Matrix3x4::Identity()
 Transform to apply to text quads.
 
bool m_monospace = false
 disable character proportional spacing
 
bool m_depthTest = false
 Test character against the depth buffer.
 
bool m_virtual800x600ScreenSize = false
 Text placement and size are scaled relative to a virtual 800x600 resolution.
 
bool m_scaleWithWindow = false
 Font gets bigger as the window gets bigger.
 
bool m_multiline = true
 text respects ascii newline characters
 

Detailed Description

Standard parameters for drawing text on screen.


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