Index · Object → RefCounted → EditorResourcePreviewGenerator

EditorResourcePreviewGenerator

Custom generator of previews.

Class Description

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

Methods

func _can_generate_small_preview() -> bool

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

By default, it returns false.

func _generate(resource: Resource, size: Vector2i, metadata: Dictionary) -> Texture2D

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

func _generate_from_path(path: String, size: Vector2i, metadata: Dictionary) -> Texture2D

Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call _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.).

func _generate_small_preview_automatically() -> bool

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.

func _handles(type: String) -> bool

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

func request_draw_and_wait(viewport: RID) -> void

Call from within _generate() to request the rendering server draw to the viewport.

Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Object (2)