Detailed Description

Represents the background image of an element. May also be a video (pro only) or animation.

Inheritance diagram for Css.BackgroundImage:

Public Member Functions
	BackgroundImage (RenderableData data)
	Creates a new displayable background image for the given element. More...

override void	OnBatchDestroy ()
	Called when the isolation batch for this property gets removed. 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...

void	SetImage (Texture2D image)
	Applies the given image to the background. More...

void	SetImage (ImagePackage package)
	Manually apply an image package to the background of this element. More...

void	ImageReady (ImagePackage package)
	A callback used when the graphic has been loaded and is ready for display. 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...

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
Css.Value	OffsetX
	How much to move the image over by on the x axis. % or px. More...

Css.Value	OffsetY
	How much to move the image over by on the y axis. % or px. More...

float	OffsetOriginX
	The width of the image (background-size property). More...

float	OffsetOriginY
	The origin that an offset is relative to. More...

Css.Value	SizeX
	The width of the image (background-size property). More...

Css.Value	SizeY
	The height of the image (background-size property). More...

bool	RepeatX =true
	True if the image should be repeated on the x axis. More...

bool	RepeatY =true
	True if the image should be repeated on the y axis. More...

ImagePackage	Image
	The graphic to display. More...

bool	ForcedIsolate
	True if this image should be isolated regardless. More...

AtlasLocation	ImageLocation
	The location of the image on an atlas if it's on one. More...

FilterMode	Filtering =FilterMode.Point
	The filter mode to display the image with. More...

BackgroundClipping	Clipping =BackgroundClipping.BorderBox
	The clipping mode of this background image. 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...

Package Functions
override void	NowOffScreen ()
	Called when this element goes off screen (or is removed from the DOM). More...

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...

Properties
override int	DrawOrder `[get]`
	This property's draw order. More...

override bool	IsBackground `[get]`
	True if this paints across the whole background of the element. 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...

Additional Inherited Members
Protected Member Functions inherited from Css.DisplayableProperty
virtual void	OnChange (string property, Value newValue)
	Called when a named css property changes. More...

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.BackgroundImage.BackgroundImage ( RenderableData data)

inline

Creates a new displayable background image for the given element.

Parameters

data	The renderable object that will have a background image applied.

Member Function Documentation

void Css.BackgroundImage.ImageReady ( ImagePackage package)

inline

A callback used when the graphic has been loaded and is ready for display.

override void Css.BackgroundImage.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 void Css.BackgroundImage.NowOffScreen ( )

inlinepackagevirtual

Called when this element goes off screen (or is removed from the DOM).

Reimplemented from Css.DisplayableProperty.

override bool Css.BackgroundImage.NowOnScreen ( )

inlinepackagevirtual

Called when this element goes on screen.

Reimplemented from Css.DisplayableProperty.

override void Css.BackgroundImage.OnBatchDestroy ( )

inlinevirtual

Called when the isolation batch for this property gets removed.

Reimplemented from Css.DisplayableProperty.

override void Css.BackgroundImage.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.

void Css.BackgroundImage.SetImage ( Texture2D image)

inline

Applies the given image to the background.

Parameters

image The image to use.

void Css.BackgroundImage.SetImage ( ImagePackage package)

inline

Manually apply an image package to the background of this element.

Member Data Documentation

BackgroundClipping Css.BackgroundImage.Clipping =BackgroundClipping.BorderBox

The clipping mode of this background image.

FilterMode Css.BackgroundImage.Filtering =FilterMode.Point

The filter mode to display the image with.

bool Css.BackgroundImage.ForcedIsolate

True if this image should be isolated regardless.

ImagePackage Css.BackgroundImage.Image

The graphic to display.

AtlasLocation Css.BackgroundImage.ImageLocation

The location of the image on an atlas if it's on one.

float Css.BackgroundImage.OffsetOriginX

The width of the image (background-size property).

float Css.BackgroundImage.OffsetOriginY

The origin that an offset is relative to.

Css.Value Css.BackgroundImage.OffsetX

How much to move the image over by on the x axis. % or px.

Css.Value Css.BackgroundImage.OffsetY

How much to move the image over by on the y axis. % or px.

bool Css.BackgroundImage.RepeatX =true

True if the image should be repeated on the x axis.

bool Css.BackgroundImage.RepeatY =true

True if the image should be repeated on the y axis.

Css.Value Css.BackgroundImage.SizeX

The width of the image (background-size property).

Css.Value Css.BackgroundImage.SizeY

The height of the image (background-size property).

Property Documentation

override int Css.BackgroundImage.DrawOrder

get

This property's draw order.

override bool Css.BackgroundImage.IsBackground

get

True if this paints across the whole background of the element.

Detailed Description

Public Member Functions

Public Attributes

Package Functions

Properties

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation