Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

SVGTexture

Inherits: Texture2D < Texture < Resource < RefCounted < Object

A scalable Texture2D based on an SVG image.

Description

A scalable Texture2D based on an SVG image. SVGTextures are automatically re-rasterized to match font oversampling.

Properties

float

base_scale

1.0

Dictionary

color_map

{}

bool

resource_local_to_scene

false (overrides Resource)

float

saturation

1.0

Methods

SVGTexture

create_from_string(source: String, scale: float = 1.0, saturation: float = 1.0, color_map: Dictionary = {}) static

String

get_source() const

void

set_size_override(size: Vector2i)

void

set_source(source: String)

Property Descriptions

float base_scale = 1.0 🔗

  • void set_base_scale(value: float)

  • float get_base_scale()

SVG texture scale. 1.0 is the original SVG size. Higher values result in a larger image.

Dictionary color_map = {} 🔗

If set, remaps SVG texture colors according to Color-Color map.

float saturation = 1.0 🔗

  • void set_saturation(value: float)

  • float get_saturation()

Overrides texture saturation.

Method Descriptions

SVGTexture create_from_string(source: String, scale: float = 1.0, saturation: float = 1.0, color_map: Dictionary = {}) static 🔗

Creates a new SVGTexture and initializes it by allocating and setting the SVG data from string.

String get_source() const 🔗

Returns SVG source code.

void set_size_override(size: Vector2i) 🔗

Resizes the texture to the specified dimensions.

void set_source(source: String) 🔗

Sets SVG source code.

User-contributed notes

Please read the User-contributed notes policy before submitting a comment.