EditorResourcePreview

Documentation

Overview

Package EditorResourcePreview provides methods for working with EditorResourcePreview object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AddPreviewGenerator(generator [1]gdclass.EditorResourcePreviewGenerator)
  • func (self Instance) AsEditorResourcePreview() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) CheckForInvalidation(path string)
  • func (self Instance) OnPreviewInvalidated(cb func(path string))
  • func (self Instance) QueueEditedResourcePreview(resource [1]gdclass.Resource, receiver Object.Instance, receiver_func string, ...)
  • func (self Instance) QueueResourcePreview(path string, receiver Object.Instance, receiver_func string, userdata any)
  • func (self Instance) RemovePreviewGenerator(generator [1]gdclass.EditorResourcePreviewGenerator)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsEditorResourcePreview() Instance
}

type Instance

type Instance [1]gdclass.EditorResourcePreview

This node is used to generate previews for resources or files. [b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_resource_previewer].

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AddPreviewGenerator

func (self Instance) AddPreviewGenerator(generator [1]gdclass.EditorResourcePreviewGenerator)

Create an own, custom preview generator.

func (Instance) AsEditorResourcePreview

func (self Instance) AsEditorResourcePreview() Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) CheckForInvalidation

func (self Instance) CheckForInvalidation(path string)

Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted.

func (Instance) OnPreviewInvalidated

func (self Instance) OnPreviewInvalidated(cb func(path string))

func (Instance) QueueEditedResourcePreview

func (self Instance) QueueEditedResourcePreview(resource [1]gdclass.Resource, receiver Object.Instance, receiver_func string, userdata any)

Queue the [param resource] being edited for preview. Once the preview is ready, the [param receiver]'s [param receiver_func] will be called. The [param receiver_func] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [param userdata] can be anything, and will be returned when [param receiver_func] is called. [b]Note:[/b] If it was not possible to create the preview the [param receiver_func] will still be called, but the preview will be null.

func (Instance) QueueResourcePreview

func (self Instance) QueueResourcePreview(path string, receiver Object.Instance, receiver_func string, userdata any)

Queue a resource file located at [param path] for preview. Once the preview is ready, the [param receiver]'s [param receiver_func] will be called. The [param receiver_func] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [param userdata] can be anything, and will be returned when [param receiver_func] is called. [b]Note:[/b] If it was not possible to create the preview the [param receiver_func] will still be called, but the preview will be null.

func (Instance) RemovePreviewGenerator

func (self Instance) RemovePreviewGenerator(generator [1]gdclass.EditorResourcePreviewGenerator)

Removes a custom preview generator.

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value