Open 3D Engine AzToolsFramework 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.
Public Attributes | List of all members
AzToolsFramework::EditorViewportIconDisplayInterface::DrawParameters Struct Reference

These draw parameters control rendering for a single icon to a single viewport. More...

#include <EditorViewportIconDisplayInterface.h>

Public Attributes

AzFramework::ViewportId m_viewport = AzFramework::InvalidViewportId
 The ViewportId to render to.
 
IconId m_icon = InvalidIconId
 The icon ID, retrieved from GetOrLoadIconForPath, to render to screen.
 
AZ::Color m_color = AZ::Colors::White
 The color, including opacity, to render the icon with. White will render the icon as opaque in its original color.
 
AZ::Vector3 m_position
 The position to render the icon to, in world or screen space depending on m_positionSpace.
 
CoordinateSpace m_positionSpace = CoordinateSpace::ScreenSpace
 
AZ::Vector2 m_size
 The size to render the icon as, in pixels.
 

Detailed Description

These draw parameters control rendering for a single icon to a single viewport.

Member Data Documentation

◆ m_positionSpace

CoordinateSpace AzToolsFramework::EditorViewportIconDisplayInterface::DrawParameters::m_positionSpace = CoordinateSpace::ScreenSpace

The coordinate system to use for m_position. ScreenSpace will accept m_position in the form of [X, Y, Depth], where X & Y are screen coordinates in pixels and Depth is a z-ordering depth value from 0.0f to 1.0f. WorldSpace will accept a 3D vector in world space coordinates that will be translated back into screen space when the icon is rendered.

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