Class EditorResourcePreviewGenerator

Custom generator of previews.

Inheritance

RefCounted

Object

EditorResourcePreviewGenerator

Remarks

Custom code to generate previews. Check filesystem/file_dialog/thumbnail_size to find a proper size to generate previews at.

Methods

_can_generate_small_preview

Qualifiers: virtualconst

If this function returns true, the generator will call EditorResourcePreviewGenerator._generate or EditorResourcePreviewGenerator._generate_from_path for small previews as well.

By default, it returns false.

bool _can_generate_small_preview

_generate(Resource, Vector2i, Dictionary)

Qualifiers: virtualconst

Generate a preview from a given resource with the specified size. This must always be implemented.

Returning null is an OK way to fail and let another generator take care.

Care must be taken because this function is always called from a thread (not the main thread).

metadata dictionary can be modified to store file-specific metadata that can be used in EditorResourceTooltipPlugin._make_tooltip_for_path (like image size, sample length etc.).

Texture2D _generate(Resource resource, Vector2i size, Dictionary metadata)

Parameters

resource Resource

size Vector2i

metadata Dictionary

_generate_from_path(String, Vector2i, Dictionary)

Qualifiers: virtualconst

Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call EditorResourcePreviewGenerator._generate.

Returning null is an OK way to fail and let another generator take care.

Care must be taken because this function is always called from a thread (not the main thread).

metadata dictionary can be modified to store file-specific metadata that can be used in EditorResourceTooltipPlugin._make_tooltip_for_path (like image size, sample length etc.).

Texture2D _generate_from_path(String path, Vector2i size, Dictionary metadata)

Parameters

path String

size Vector2i

metadata Dictionary

_generate_small_preview_automatically

Qualifiers: virtualconst

If this function returns true, the generator will automatically generate the small previews from the normal preview texture generated by the methods EditorResourcePreviewGenerator._generate or EditorResourcePreviewGenerator._generate_from_path.

By default, it returns false.

bool _generate_small_preview_automatically

_handles(String)

Qualifiers: virtualconst

Returns true if your generator supports the resource of type type.

bool _handles(String type)

Parameters

type String