Common types used across the LyShine UI system. More...

Classes
class	CanvasAsset

class	FontAsset

class	IRenderGraph

class	LyShineRequests

struct	UCol

struct	UiPrimitive

struct	UiPrimitiveVertex

Typedefs
using	LyShineRequestBus = AZ::EBus< LyShineRequests >

typedef AZStd::string	NameType
	used for UI element names and canvas names, should be the same as the AZ::Entity name type

typedef AZStd::string	PathnameType
	Used for pathnames for UI canvas and prefab files.

typedef unsigned int	CanvasId

typedef unsigned int	ElementId

typedef AZStd::string	ActionName
	Used for UI action names.

typedef AZStd::string	StringType
	Used for test strings in UI text elements.

typedef AZStd::vector< AZ::Entity *, AZ::StdLegacyAllocator >	EntityArray
	Used for passing lists of entities.

typedef AZStd::unordered_map< AZ::EntityId, AZ::EntityId >	EntityIdMap

using	UiIndice = AZ::u16

using	UiPrimitiveList = AZStd::intrusive_slist< UiPrimitive, AZStd::slist_base_hook< UiPrimitive > >

Enumerations
enum	BlendMode { BlendMode::Normal, BlendMode::Add, BlendMode::Screen, BlendMode::Darken, BlendMode::Lighten }

Functions
bool	IsUiLayoutCellSizeSpecified (float size)

template<typename T >
bool	ConvertSubElementFromAzStringToAssetRef (AZ::SerializeContext &context, AZ::SerializeContext::DataElementNode &classElement, const char *subElementName)

bool	ConvertSubElementFromCharToUInt32 (AZ::SerializeContext &context, AZ::SerializeContext::DataElementNode &classElement, const char *subElementName)

template<typename T >
bool	GetSubElementValue (AZ::SerializeContext::DataElementNode &classElement, const char *elementName, T &value)

ColorF	MakeColorF (AZ::Vector3 color, float alpha)

AZ::Vector3	MakeColorVector3 (ColorF color)

AZ::Color	MakeColorAZColor (ColorF color)

bool	ConvertSubElementFromColorToColorPlusAlpha (AZ::SerializeContext &context, AZ::SerializeContext::DataElementNode &classElement, const char colorElementName, const char alphaElementName)

bool	ConvertSubElementFromVector3ToAzColor (AZ::SerializeContext &context, AZ::SerializeContext::DataElementNode &classElement, const char *colorElementName)

bool	ConvertSubElementFromColorFToAzColor (AZ::SerializeContext &context, AZ::SerializeContext::DataElementNode &classElement, const char *colorElementName)

bool	ConvertSubElementFromVec2ToVector2 (AZ::SerializeContext &context, AZ::SerializeContext::DataElementNode &classElement, const char *vec2ElementName)

bool	MoveElement ([[maybe_unused]] AZ::SerializeContext &context, AZ::SerializeContext::DataElementNode &srcElement, AZ::SerializeContext::DataElementNode &dstElement, const char srcSubElementName, const char dstSubElementName)

bool	RemoveLeadingForwardSlashesFromAssetPath (AZ::SerializeContext &context, AZ::SerializeContext::DataElementNode &classElement, const char *simpleAssetRefSubElementName)

AZ::SerializeContext::DataElementNode *	FindComponentNode (AZ::SerializeContext::DataElementNode &entityNode, const AZ::Uuid &uuid)

bool	CreateEntityIdNode (AZ::SerializeContext &context, AZ::SerializeContext::DataElementNode &entityNode)

bool	CreateComponentBaseClassNode (AZ::SerializeContext &context, AZ::SerializeContext::DataElementNode &componentNode)

Variables
const char *const	UiButtonComponentUuid = "{7329DFE8-0F3C-4629-B395-78B2CF646B96}"

const char *const	UiCanvasComponentUuid = "{50B8CF6C-B19A-4D86-AFE9-96EFB820D422}"

const char *const	UiCheckboxComponentUuid = "{68D62281-B360-4426-AACA-E8BDE8BFEB3A}"

const char *const	UiDraggableComponentUuid = "{C96B1EEF-033A-479B-829B-ED3555D0F33A}"

const char *const	UiDropTargetComponentUuid = "{E4B8ACE0-FCE7-42D8-9836-942F910168B4}"

const char *const	UiDropdownComponentUuid = "{BFC4D5A3-2F7C-4079-B19C-C2A06E93F343}"

const char *const	UiDropdownOptionComponentUuid = "{554E16E4-CBA1-4E57-B326-9731AA963BAA}"

const char *const	UiDynamicLayoutComponentUuid = "{690BEC14-3642-4247-BD96-FE414CCB7DE7}"

const char *const	UiDynamicScrollBoxComponentUuid = "{6982C200-4D32-43CC-A7F6-F54FA50FCFF5}"

const char *const	UiElementComponentUuid = "{4A97D63E-CE7A-45B6-AAE4-102DB4334688}"

const char *const	UiFaderComponentUuid = "{CD01FF77-2249-4ED8-BFFB-33A66A47E17C}"

const char *const	UiFlipbookAnimationComponentUuid ="{AACCFFA1-B694-4F8B-A289-391A56404E0C}"

const char *const	UiImageComponentUuid = "{BDBEFD23-DBB4-4726-A32D-4FEAC24E51F6}"

const char *const	UiImageSequenceComponentUuid = "{BFAC7909-3A56-4980-AF7C-261A99D6371B}"

const char *const	UiLayoutColumnComponentUuid = "{4BC2E786-360B-4426-8D9C-9B254C5EA21F}"

const char *const	UiLayoutCellComponentUuid = "{A0568E58-4382-47F8-8B88-77C64B99AC80}"

const char *const	UiLayoutFitterComponentUuid = "{96C55390-9D03-4C47-BB0D-17D3BD5219E3}"

const char *const	UiLayoutGridComponentUuid = "{ADDA3AE5-B9AB-44B7-A462-8B89B398A837}"

const char *const	UiLayoutRowComponentUuid = "{7B2820C4-7FC7-4F02-B777-6727EB4BAC13}"

const char *const	UiMarkupButtonComponentUuid = "{D7EB1706-75E8-4C94-A266-61913F42431B}"

const char *const	UiMaskComponentUuid = "{2279AA38-271D-4D4F-A472-E42B984088AC}"

const char *const	UiParticleEmitterComponentUuid = "{E8B1288C-CB49-4CAD-B366-AF1B40C47E74}"

const char *const	UiRadioButtonComponentUuid = "{773A0F4B-F9F9-4B82-9951-BBD73A737DE4}"

const char *const	UiRadioButtonGroupComponentUuid = "{F89D5EF2-37C4-4CA7-9AA2-23DC3867EC9D}"

const char *const	UiScrollBarComponentUuid = "{6B283F90-3519-47DA-A1DD-65A79CE119CF}"

const char *const	UiScrollBoxComponentUuid = "{2F539588-AEAB-4341-A6A6-AF645D129693}"

const char *const	UiSliderComponentUuid = "{2913D76B-36A0-45E0-A104-33C668EB612D}"

const char *const	UiTextComponentUuid = "{5B3FB2A7-5DC4-4033-A970-001CEC85B6C4}"

const char *const	UiTextInputComponentUuid = "{2CB3872B-D2B4-4DDB-B39A-97492310AE11}"

const char *const	UiTooltipComponentUuid = "{493EBF89-C299-4722-829D-4DFAB926795B}"

const char *const	UiTooltipDisplayComponentUuid = "{18CEE6A7-3CBC-4638-9F4D-87E8D53DDF1A}"

const char *const	UiTransform2dComponentUuid = "{2751A5A5-3291-4A4D-9FC0-9CB0EB8D1DE6}"

const char *const	lyShineSystemComponentUuid = "{B0C78B8D-1E5B-47D7-95D0-EC69C0513804}"

const float	UiLayoutCellUnspecifiedSize = -1.0f

Detailed Description

Common types used across the LyShine UI system.

Common types used across the LyShine UI layout cell system.

Typedef Documentation

◆ CanvasId

typedef unsigned int LyShine::CanvasId

USed for our 32-bit id's for canvases and elements. Only used so FlowGraph can reference these things These should go away once FlowGraph can used AZ::EntityIds

Enumeration Type Documentation

◆ BlendMode

enum LyShine::BlendMode

strong

Enumerator
Normal	interpolate from dest color to source color according to source alpha
Add	source color * source alpha is added to dest color (Linear Dodge)
Screen	as close as we can get to Photoshop Screen
Darken	like Photoshop darken
Lighten	like Photoshop lighten

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ CanvasId

Enumeration Type Documentation

◆ BlendMode