OverlayModule.hpp File Reference

Classes
struct	castor3d::TextChar
	A character, along with its size and relative position. More...
struct	castor3d::TextWord
	A text chars container, along with its size and position. More...
struct	castor3d::OverlayWords
	Contains the words forming the overlay. More...
struct	castor3d::TextLine
	A text chars container, along with its size and position. More...
struct	castor3d::OverlayLines
	Contains the lines forming the overlay. More...
struct	castor3d::PtrCacheTraitsT< Overlay, castor::String >

Namespaces
namespace	castor3d
namespace	castor

Functions
Frame
	castor3d::CU_DeclareSmartPtr (castor3d, FrameListenerCache, C3D_API)

Overlay
enum class	castor3d::OverlayType : uint8_t {   castor3d::ePanel = 0 , castor3d::eBorderPanel = 1 , castor3d::eText = 2 , castor3d::eCount ,   castor3d::eMin = ePanel }
	Overlay types enumeration. More...
enum class	castor3d::TextWrappingMode {   castor3d::eNone = 0 , castor3d::eBreak = 1 , castor3d::eBreakWords = 2 , castor3d::eCount ,   castor3d::eMin = eNone }
	Text wrapping modes, handles the way text is cut when it overflows the overlay width. More...
enum class	castor3d::TextTexturingMode { castor3d::eLetter = 0 , castor3d::eText = 1 , castor3d::eCount , castor3d::eMin = eLetter }
	Text texturing modes, handles the way textures are appied to text overlays. More...
enum class	castor3d::TextLineSpacingMode {   castor3d::eOwnHeight = 0 , castor3d::eMaxLineHeight = 1 , castor3d::eMaxFontHeight = 2 , castor3d::eCount ,   castor3d::eMin = eOwnHeight }
	Text line spacing modes, handles the way lines are spaced, which each other, inside one TextOverlay. More...
enum class	castor3d::HAlign {   castor3d::eLeft = 0 , castor3d::eCenter = 1 , castor3d::eRight = 2 , castor3d::eCount ,   castor3d::eMin = eLeft }
	Horizontal alignments for text overlays. More...
enum class	castor3d::VAlign {   castor3d::eTop = 0 , castor3d::eCenter = 1 , castor3d::eBottom = 2 , castor3d::eCount ,   castor3d::eMin = eTop }
	Vertical alignments for text overlays. More...
enum class	castor3d::BorderPosition {   castor3d::eInternal = 0 , castor3d::eMiddle = 1 , castor3d::eExternal = 2 , castor3d::eCount ,   castor3d::eMin = eInternal }
	Text wrapping modes, handles the way text is cut when it overflows the overlay width. More...
using	castor3d::OverlayCacheTraits = PtrCacheTraitsT< Overlay, castor::String >
using	castor3d::OverlayCache
using	castor3d::OverlayRes = OverlayCacheTraits::ElementPtrT
using	castor3d::OverlayResPtr = OverlayCacheTraits::ElementObsT
C3D_API castor::String	castor3d::getName (OverlayType value)
C3D_API castor::String	castor3d::getName (TextWrappingMode value)
C3D_API castor::String	castor3d::getName (TextTexturingMode value)
C3D_API castor::String	castor3d::getName (TextLineSpacingMode value)
C3D_API castor::String	castor3d::getName (HAlign value)
C3D_API castor::String	castor3d::getName (VAlign value)
C3D_API castor::String	castor3d::getName (BorderPosition value)
	castor3d::CU_DeclareSmartPtr (castor3d, BorderPanelOverlay, C3D_API)
	castor3d::CU_DeclareSmartPtr (castor3d, DebugOverlays, C3D_API)
	castor3d::CU_DeclareSmartPtr (castor3d, FontTexture, C3D_API)
	castor3d::CU_DeclareSmartPtr (castor3d, Overlay, C3D_API)
	castor3d::CU_DeclareSmartPtr (castor3d, OverlayCategory, C3D_API)
	castor3d::CU_DeclareSmartPtr (castor3d, OverlayFactory, C3D_API)
	castor3d::CU_DeclareSmartPtr (castor3d, PanelOverlay, C3D_API)
	castor3d::CU_DeclareSmartPtr (castor3d, TextOverlay, C3D_API)
	castor3d::CU_DeclareSmartPtr (castor3d, OverlayContext, C3D_API)
	castor3d::CU_DeclareVector (OverlayRPtr, OverlayPtr)
	castor3d::CU_DeclareMap (castor::String, OverlayResPtr, OverlayPtrStr)