Detailed Description

Represents the SVG Image format.

Inheritance diagram for Svg.SVGFormat:
PowerUI.ImageFormat

Public Member Functions

 SVGFormat ()
 
 SVGFormat (SVG svg)
 
override bool LoadData (byte[] data, ImagePackage package)
 Loads the raw block of data into an object of this format. More...
 
override void OnLayout (Css.RenderableData context, LayoutBox box, out float width, out float height)
 Called just before the image is about to be drawn (only ever when it's actually visible). Note that everything else - e.g. ImageMaterial or Width/Height - is always called after this. More...
 
override string[] GetNames ()
 The set of lowercase file types that this format will handle. More...
 
override Material GetImageMaterial (ShaderSet shaders)
 A single-frame image material. Used for e.g. videos and animations. More...
 
override ImageFormat Instance ()
 Creates an instance of this format. More...
 
override void ClearX ()
 Resets this image format container. More...
 
- Public Member Functions inherited from PowerUI.ImageFormat
virtual int GetAtlasID ()
 Get the identifier used for this content on an atlas. More...
 
Material GetImageMaterial ()
 A single-frame image material using the standard UI shader set. Used for e.g. videos and animations. More...
 
virtual bool InternallyCached (Location path, ImagePackage package)
 Some formats may cache their result internally. This checks and updates if it has. More...
 
virtual bool LoadFromAsset (UnityEngine.Object asset, ImagePackage package)
 Attempt to load the image from a Unity resource. More...
 
virtual void OnLayout (RenderableData context, LayoutBox box, out float width, out float height)
 Called when the host element is drawing. More...
 
virtual void GoingOnDisplay (Css.RenderableData context)
 Called when this image is going to be displayed. More...
 
virtual void GoingOffDisplay ()
 Called when this image is going to stop being displayed. More...
 
virtual bool DrawToAtlas (TextureAtlas atlas, AtlasLocation location)
 Draws this image to the given atlas. More...
 

Public Attributes

SVG Svg
 The SVG retrieved. More...
 
RenderContext Context
 The latest render context. More...
 

Properties

override bool Isolate [get]
 
override int Height [get]
 
override int Width [get]
 
override bool Loaded [get]
 
- Properties inherited from PowerUI.ImageFormat
virtual int Height [get]
 The height of the image. More...
 
virtual int Width [get]
 The width of the image. More...
 
virtual FilterMode FilterMode [get, set]
 Get/set the filter mode. More...
 
virtual bool Loaded [get]
 Is this image loaded? More...
 
virtual bool Isolate [get]
 Should this image be isolated - i.e. off atlas. More...
 

Private Attributes

Material IsolatedMaterial
 An isolated material for this image. More...
 

Constructor & Destructor Documentation

Svg.SVGFormat.SVGFormat ( )
inline
Svg.SVGFormat.SVGFormat ( SVG  svg)
inline

Member Function Documentation

override void Svg.SVGFormat.ClearX ( )
inlinevirtual

Resets this image format container.

Reimplemented from PowerUI.ImageFormat.

override Material Svg.SVGFormat.GetImageMaterial ( ShaderSet  shaders)
inlinevirtual

A single-frame image material. Used for e.g. videos and animations.

Reimplemented from PowerUI.ImageFormat.

override string [] Svg.SVGFormat.GetNames ( )
inlinevirtual

The set of lowercase file types that this format will handle.

Reimplemented from PowerUI.ImageFormat.

override ImageFormat Svg.SVGFormat.Instance ( )
inlinevirtual

Creates an instance of this format.

Reimplemented from PowerUI.ImageFormat.

override bool Svg.SVGFormat.LoadData ( byte[]  data,
ImagePackage  package 
)
inlinevirtual

Loads the raw block of data into an object of this format.

Reimplemented from PowerUI.ImageFormat.

override void Svg.SVGFormat.OnLayout ( Css.RenderableData  context,
LayoutBox  box,
out float  width,
out float  height 
)
inline

Called just before the image is about to be drawn (only ever when it's actually visible). Note that everything else - e.g. ImageMaterial or Width/Height - is always called after this.

Member Data Documentation

RenderContext Svg.SVGFormat.Context

The latest render context.

Material Svg.SVGFormat.IsolatedMaterial
private

An isolated material for this image.

SVG Svg.SVGFormat.Svg

The SVG retrieved.

Property Documentation

override int Svg.SVGFormat.Height
get
override bool Svg.SVGFormat.Isolate
get
override bool Svg.SVGFormat.Loaded
get
override int Svg.SVGFormat.Width
get