Class SVGResource

Resource type for SVG elements and graphics.

Memberof

PIXI

Hierarchy (View Summary)

BaseImageResource
- SVGResource

Index

Constructors

constructor

new SVGResource(
sourceBase64: string,
options?: ISVGResourceOptions,
): SVGResource
Parameters
- sourceBase64: string
  Base64 encoded SVG element or URL for SVG file.
- Optionaloptions: ISVGResourceOptions
  Options to use
  - OptionalautoLoad?: boolean
  - Optionalcrossorigin?: string | boolean
  - Optionalheight?: number
  - Optionalscale?: number
  - Optionalsource?: string
  - Optionalwidth?: number
Returns SVGResource
Overrides BaseImageResource.constructor

Properties

`Readonly`_overrideHeight

_overrideHeight: number

A height override for rasterization on load.

`Readonly`_overrideWidth

_overrideWidth: number

A width override for rasterization on load.

`Readonly`destroyed

destroyed: boolean

If resource has been destroyed.

Default

false

internal

internal: boolean

true if resource is created by BaseTexture useful for doing cleanup with BaseTexture destroy and not cleaning up resources that were created externally.

`Readonly`scale

scale: number

The source scale to apply when rasterizing on load.

`Readonly`source

source: ImageSource

The source element.

Member

src

src: string

The url of the resource

`Readonly`svg

svg: string

Base64 encoded SVG element or URL for SVG file.

`Static` `Readonly`SVG_SIZE

SVG_SIZE: RegExp

Regular expression for SVG size.

Example

&lt;svg width="100" height="100"&gt;&lt;/svg&gt;
@readonly

`Static` `Readonly`SVG_XML

SVG_XML: RegExp

Regular expression for SVG XML document.

Example

&lt;?xml version="1.0" encoding="utf-8" ?&gt;&lt;!-- image/svg --&gt;&lt;svg
@readonly

Accessors

height

get height(): number
The height of the resource.

Returns number
Inherited from BaseImageResource.height

valid

get valid(): boolean
Has been validated

Returns boolean
Inherited from BaseImageResource.valid

width

get width(): number
The width of the resource.

Returns number
Inherited from BaseImageResource.width

Methods

bind

bind(baseTexture: BaseTexture): void
Bind to a parent BaseTexture
Parameters
- baseTexture: BaseTexture
  Parent texture
Returns void
Inherited from BaseImageResource.bind

destroy

destroy(): void
Call when destroying resource, unbind any BaseTexture object before calling this method, as reference counts are maintained internally.

Returns void
Inherited from BaseImageResource.destroy

dispose

dispose(): void
Destroys this texture.

Returns void
Overrides BaseImageResource.dispose

resize

resize(width: number, height: number): void
Trigger a resize event
Parameters
- width: number
  X dimension
- height: number
  Y dimension
Returns void
Inherited from BaseImageResource.resize

style

style(
    _renderer: Renderer,
    _baseTexture: BaseTexture,
    _glTexture: GLTexture,
): boolean
Set the style, optional to override
Parameters
- _renderer: Renderer
  yeah, renderer!
- _baseTexture: BaseTexture
  the texture
- _glTexture: GLTexture
  texture instance for this webgl context
Returns boolean
- true is success
Inherited from BaseImageResource.style

unbind

unbind(baseTexture: BaseTexture): void
Unbind to a parent BaseTexture
Parameters
- baseTexture: BaseTexture
  Parent texture
Returns void
Inherited from BaseImageResource.unbind

update

update(): void
Checks if source width/height was changed, resize can cause extra baseTexture update. Triggers one update in any case.

Returns void
Inherited from BaseImageResource.update

upload

upload(
    renderer: Renderer,
    baseTexture: BaseTexture,
    glTexture: GLTexture,
    source?: ImageSource,
): boolean
Upload the texture to the GPU.
Parameters
- renderer: Renderer
  Upload to the renderer
- baseTexture: BaseTexture
  Reference to parent texture
- glTexture: GLTexture
- Optionalsource: ImageSource
  (optional)
Returns boolean
- true is success
Inherited from BaseImageResource.upload

`Static`crossOrigin

crossOrigin(
    element: HTMLImageElement | HTMLVideoElement,
    url: string,
    crossorigin?: string | boolean,
): void
Set cross origin based detecting the url and the crossorigin
Parameters
- element: HTMLImageElement | HTMLVideoElement
  Element to apply crossOrigin
- url: string
  URL to check
- Optionalcrossorigin: string | boolean
  Cross origin value to use
Returns void
Inherited from BaseImageResource.crossOrigin

`Static`getSize

getSize(svgString?: string): ISize
Get size from an svg string using a regular expression.
Parameters
- OptionalsvgString: string
  a serialized svg element
Returns ISize
- image extension

`Static`test

test(source: unknown, extension?: string): boolean
Used to auto-detect the type of resource.
Parameters
- source: unknown
  The source object
- Optionalextension: string
  The extension of source, if set
Returns boolean
- If the source is a SVG source or data file
Overrides BaseImageResource.test

Class SVGResource

Memberof

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalautoLoad?: boolean

Optionalcrossorigin?: string | boolean

Optionalheight?: number

Optionalscale?: number

Optionalsource?: string

Optionalwidth?: number

Returns SVGResource

Properties

Readonly_overrideHeight

Readonly_overrideWidth

Readonlydestroyed

Default

internal

Readonlyscale

Readonlysource

Member

src

Readonlysvg

Static ReadonlySVG_SIZE

Example

Static ReadonlySVG_XML

Example

Accessors

height

Returns number

valid

Returns boolean

width

Returns number

Methods

bind

Parameters

Returns void

destroy

Returns void

dispose

Returns void

resize

Parameters

Returns void

style

Parameters

Returns boolean

unbind

Parameters

Returns void

update

Returns void

upload

Parameters

Returns boolean

StaticcrossOrigin

Parameters

Returns void

StaticgetSize

Parameters

Returns ISize

Statictest

Parameters

Returns boolean

Settings

On This Page

`Optional`autoLoad?: boolean

`Optional`crossorigin?: string | boolean

`Optional`height?: number

`Optional`scale?: number

`Optional`source?: string

`Optional`width?: number

`Readonly`_overrideHeight

`Readonly`_overrideWidth

`Readonly`destroyed

`Readonly`scale

`Readonly`source

`Readonly`svg

`Static` `Readonly`SVG_SIZE

`Static` `Readonly`SVG_XML

`Static`crossOrigin

`Static`getSize

`Static`test