PowerUI.ImageFormat Class Reference

Detailed Description

Represents a specific type of image format, e.g. a video or an SVG.

Inheritance diagram for PowerUI.ImageFormat:

Public Member Functions
virtual string[]	GetNames ()
	The set of lowercase file types that this format will handle. More...
virtual int	GetAtlasID ()
	Get the identifier used for this content on an atlas. More...
virtual ImageFormat	Instance ()
	Creates an instance of this format. More...
Material	GetImageMaterial ()
	A single-frame image material using the standard UI shader set. Used for e.g. videos and animations. More...
virtual Material	GetImageMaterial (ShaderSet shaders)
	A single-frame image material. 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 bool	LoadData (byte[] data, ImagePackage package)
	Loads the raw block of data into an object of this format. More...
virtual void	OnLayout (RenderableData context, LayoutBox box, out float width, out float height)
	Called when the host element is drawing. More...
virtual void	ClearX ()
	Resets this image format container. 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...

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

Member Function Documentation

virtual void PowerUI.ImageFormat.ClearX ( )

inlinevirtual

Resets this image format container.

Reimplemented in PowerUI.DynamicTexture, Spa.SpaFormat, Svg.SVGFormat, Gif.GifFormat, and Css.SparkSpecialImageFormat.

virtual bool PowerUI.ImageFormat.DrawToAtlas ( TextureAtlas  atlas, AtlasLocation  location  )

inlinevirtual

Draws this image to the given atlas.

Reimplemented in PowerUI.PictureFormat.

virtual int PowerUI.ImageFormat.GetAtlasID ( )

inlinevirtual

Get the identifier used for this content on an atlas.

Reimplemented in PowerUI.PictureFormat.

Material PowerUI.ImageFormat.GetImageMaterial ( )

inline

A single-frame image material using the standard UI shader set. Used for e.g. videos and animations.

virtual Material PowerUI.ImageFormat.GetImageMaterial ( ShaderSet  shaders)

inlinevirtual

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

Reimplemented in PowerUI.DynamicTexture, PowerUI.PictureFormat, Svg.SVGFormat, Gif.GifFormat, Spa.SpaFormat, PowerUI.VideoFormat, and Css.SparkSpecialImageFormat.

virtual string [] PowerUI.ImageFormat.GetNames ( )

inlinevirtual

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

Reimplemented in PowerUI.DynamicTexture, PowerUI.CameraFormat, Svg.SVGFormat, PowerUI.PictureFormat, Gif.GifFormat, Spa.SpaFormat, PowerUI.VideoFormat, and Css.SparkSpecialImageFormat.

virtual void PowerUI.ImageFormat.GoingOffDisplay ( )

inlinevirtual

Called when this image is going to stop being displayed.

Reimplemented in Spa.SpaFormat, and Gif.GifFormat.

virtual void PowerUI.ImageFormat.GoingOnDisplay ( Css.RenderableData  context)

inlinevirtual

Called when this image is going to be displayed.

Reimplemented in Spa.SpaFormat, Gif.GifFormat, and PowerUI.VideoFormat.

virtual ImageFormat PowerUI.ImageFormat.Instance ( )

inlinevirtual

Creates an instance of this format.

Reimplemented in PowerUI.DynamicTexture, PowerUI.CameraFormat, Gif.GifFormat, Spa.SpaFormat, Svg.SVGFormat, PowerUI.VideoFormat, PowerUI.PictureFormat, and Css.SparkSpecialImageFormat.

virtual bool PowerUI.ImageFormat.InternallyCached ( Location  path, ImagePackage  package  )

inlinevirtual

Some formats may cache their result internally. This checks and updates if it has.

Reimplemented in Gif.GifFormat, and Spa.SpaFormat.

virtual bool PowerUI.ImageFormat.LoadData ( byte[]  data, ImagePackage  package  )

inlinevirtual

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

Reimplemented in PowerUI.PictureFormat, Gif.GifFormat, Spa.SpaFormat, and Svg.SVGFormat.

virtual bool PowerUI.ImageFormat.LoadFromAsset ( UnityEngine.Object  asset, ImagePackage  package  )

inlinevirtual

Attempt to load the image from a Unity resource.

Reimplemented in PowerUI.PictureFormat, and PowerUI.VideoFormat.

virtual void PowerUI.ImageFormat.OnLayout ( RenderableData  context, LayoutBox  box, out float  width, out float  height  )

inlinevirtual

Called when the host element is drawing.

Reimplemented in Css.SparkSpecialImageFormat.

Property Documentation

virtual FilterMode PowerUI.ImageFormat.FilterMode

getset

Get/set the filter mode.

virtual int PowerUI.ImageFormat.Height

get

The height of the image.

virtual bool PowerUI.ImageFormat.Isolate

get

Should this image be isolated - i.e. off atlas.

virtual bool PowerUI.ImageFormat.Loaded

get

Is this image loaded?

virtual int PowerUI.ImageFormat.Width

get

The width of the image.