Detailed Description

Handles the rendering of text shadows.

Inheritance diagram for Css.TextShadowProperty:
Css.DisplayableProperty

Public Member Functions

 TextShadowProperty (RenderableData data)
 Creates a new text rendering property. Note that this must not be called directly More...
 
override void Paint (LayoutBox box, Renderman renderer)
 Called when a paint event occurs. Paint events don't relocate the whole UI so are quick and efficient. More...
 
virtual void DrawUnderline (Renderman renderer)
 Draws an underline (or a strikethrough). More...
 
void DrawEmoji (Glyph character, ref float left, Renderman renderer)
 Draws the given Emoji character. More...
 
- Public Member Functions inherited from Css.DisplayableProperty
 DisplayableProperty (RenderableData data)
 Creates a new displayable property for the given render data. More...
 
MeshBlock GetFirstBlock (Renderman renderer)
 Gets the first rendered block of this property. Used during Paint passes. More...
 
void SetVisibility (bool visible)
 Call this when the visibility of this property as a whole changes. More...
 
virtual void OnBatchDestroy ()
 Called when the isolation batch for this property gets removed. More...
 
void Change (string property, Value newValue)
 Called when a named css property changes. More...
 
void ClearBlocks ()
 Clears all mesh blocks that this property has allocated. More...
 
void WentOffScreen ()
 
virtual bool Render (bool first, LayoutBox box, Renderman renderer)
 Make this property visible by forcing it to redraw. More...
 
virtual void ApplyTransform (Matrix4x4 delta, Renderman renderer)
 Transforms all the verts by the given delta matrix. Used during a Paint only. More...
 
virtual void RequestPaint ()
 Requests for a paint event to occur. Note that paint events are more efficient than a layout as they only refresh the mesh colours and uvs rather than the whole mesh. More...
 
void SetBatchMaterial (Renderman renderer, Material material)
 Sets the current batches material. More...
 
void RequestLayout ()
 Requests for a layout event to occur. Note that paint events are more efficient than a layout as they only refresh the mesh colours and uvs rather than the whole mesh. More...
 
MeshBlock Add (Renderman renderer)
 
virtual void PostProcess (LayoutBox box, Renderman renderer)
 Called after a render pass. More...
 
void Isolate ()
 Isolates this property from the rest of the UI such that it can have a custom mesh/shader/texture etc. More...
 
void Include ()
 Reverses Css.DisplayableProperty.Isolate by re-including this property in the main UI batch. More...
 
bool IsIsolated ()
 Checks if this is an isolated property - that's one which is seperate and takes its own drawcall. More...
 
AtlasLocation RequireImage (AtlasEntity image)
 

Public Attributes

TextRenderingProperty Text
 The "host" text property. More...
 
float Blur
 How blurry the shadow is. More...
 
float HOffset
 Horizontal shadow offset. More...
 
float VOffset
 Vertical shadow offset. More...
 
Color Colour
 The shadow colour. More...
 
- Public Attributes inherited from Css.DisplayableProperty
bool Visible
 True if this is currently visible on screen. More...
 
bool Isolated
 True if this property is isolated and has a seperate mesh and material from everything else. More...
 
short BlockCount
 The number of mesh blocks that this property has allocated. More...
 
RenderableData RenderData
 The parent render data that this is a property of. More...
 
bool GotBatchAlready
 Only applies to Isolated properties. Set to true when this property has allocated a UIBatch on the current layout. More...
 

Protected Member Functions

virtual void DrawInvertCharacter (ref float left, Renderman renderer)
 Draws a character with x-inverted UV's. Used for rendering e.g. "1 < 2" in right-to-left. More...
 
virtual void DrawCharacter (ref float left, Renderman renderer)
 Draws a character and advances the pen onwards. More...
 
- Protected Member Functions inherited from Css.DisplayableProperty
virtual void OnChange (string property, Value newValue)
 Called when a named css property changes. More...
 

Package Functions

override bool NowOnScreen ()
 Called when this element goes on screen. More...
 
override void Layout (LayoutBox box, Renderman renderer)
 Called when a layout event occurs. Layout events relocate the whole UI so should be used less frequently than a paint event. More...
 
- Package Functions inherited from Css.DisplayableProperty
virtual void NowOffScreen ()
 Called when this element goes off screen (or is removed from the DOM). More...
 

Properties

override int DrawOrder [get]
 This property's draw order. More...
 
- Properties inherited from Css.DisplayableProperty
virtual int DrawOrder [get]
 This property's draw order. More...
 
virtual bool IsBackground [get]
 True if this paints across the whole background of the element. More...
 
bool Paintable [get]
 Checks if this property can be repainted. More...
 

Private Attributes

float FontSizeScaled
 Text.FontSize * A blur scale. More...
 
float TextOffsetFactor
 The horizontal/vertical text offset factor. More...
 

Additional Inherited Members

- Package Attributes inherited from Css.DisplayableProperty
UIBatch Batch
 The batch that this was allocated to. More...
 
int FirstBlockIndex
 The block index in the first buffer. With this, all blocks belonging to this property can be quickly discovered. More...
 

Constructor & Destructor Documentation

Css.TextShadowProperty.TextShadowProperty ( RenderableData  data)
inline

Creates a new text rendering property. Note that this must not be called directly

  • it's only ever used by the "content" CSS property. Set content: instead; if you're doing that from a tag, take a look at BR.
Parameters
dataThe renderable object that this is rendering text for.

Member Function Documentation

virtual void Css.TextShadowProperty.DrawCharacter ( ref float  left,
Renderman  renderer 
)
inlineprotectedvirtual

Draws a character and advances the pen onwards.

void Css.TextShadowProperty.DrawEmoji ( Glyph  character,
ref float  left,
Renderman  renderer 
)
inline

Draws the given Emoji character.

virtual void Css.TextShadowProperty.DrawInvertCharacter ( ref float  left,
Renderman  renderer 
)
inlineprotectedvirtual

Draws a character with x-inverted UV's. Used for rendering e.g. "1 < 2" in right-to-left.

virtual void Css.TextShadowProperty.DrawUnderline ( Renderman  renderer)
inlinevirtual

Draws an underline (or a strikethrough).

override void Css.TextShadowProperty.Layout ( LayoutBox  box,
Renderman  renderer 
)
inlinepackagevirtual

Called when a layout event occurs. Layout events relocate the whole UI so should be used less frequently than a paint event.

Reimplemented from Css.DisplayableProperty.

override bool Css.TextShadowProperty.NowOnScreen ( )
inlinepackagevirtual

Called when this element goes on screen.

Reimplemented from Css.DisplayableProperty.

override void Css.TextShadowProperty.Paint ( LayoutBox  box,
Renderman  renderer 
)
inlinevirtual

Called when a paint event occurs. Paint events don't relocate the whole UI so are quick and efficient.

Reimplemented from Css.DisplayableProperty.

Member Data Documentation

float Css.TextShadowProperty.Blur

How blurry the shadow is.

Color Css.TextShadowProperty.Colour

The shadow colour.

float Css.TextShadowProperty.FontSizeScaled
private

Text.FontSize * A blur scale.

float Css.TextShadowProperty.HOffset

Horizontal shadow offset.

TextRenderingProperty Css.TextShadowProperty.Text

The "host" text property.

float Css.TextShadowProperty.TextOffsetFactor
private

The horizontal/vertical text offset factor.

float Css.TextShadowProperty.VOffset

Vertical shadow offset.

Property Documentation

override int Css.TextShadowProperty.DrawOrder
get

This property's draw order.