EditorResourcePreviewGenerator

Inherits: Reference < Object

Custom generator of previews.

Description

Custom code to generate previews. Please check file_dialog/thumbnail_size in EditorSettings to find out the right size to do previews at.

Methods

bool	can_generate_small_preview ( ) virtual
Texture	generate ( Resource from, Vector2 size ) virtual
Texture	generate_from_path ( String path, Vector2 size ) virtual
bool	generate_small_preview_automatically ( ) virtual
bool	handles ( String type ) virtual

Method Descriptions

bool can_generate_small_preview ( ) virtual

If this function returns true, the generator will call generate or generate_from_path for small previews as well.

By default, it returns false.

Texture generate ( Resource from, Vector2 size ) virtual

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

Returning an empty texture 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).

Texture generate_from_path ( String path, Vector2 size ) virtual

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

Returning an empty texture 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).

bool generate_small_preview_automatically ( ) virtual

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

By default, it returns false.

bool handles ( String type ) virtual

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