Documentation
¶
Overview ¶
This node is used to generate previews for resources or files.
Note: This class shouldn't be instantiated directly. Instead, access the singleton using graphics.gd/classdb/EditorInterface.GetResourcePreviewer.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AddPreviewGenerator(generator EditorResourcePreviewGenerator.Instance)
- 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) ID() ID
- func (self Instance) OnPreviewInvalidated(cb func(path string), flags ...Signal.Flags)
- func (self Instance) QueueEditedResourcePreview(resource Resource.Instance, 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 EditorResourcePreviewGenerator.Instance)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsEditorResourcePreview ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.EditorResourcePreview
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AddPreviewGenerator ¶
func (self Instance) AddPreviewGenerator(generator EditorResourcePreviewGenerator.Instance)
Create an own, custom preview generator.
func (Instance) AsEditorResourcePreview ¶
func (Instance) CheckForInvalidation ¶
Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted.
func (Instance) OnPreviewInvalidated ¶
func (Instance) QueueEditedResourcePreview ¶
func (self Instance) QueueEditedResourcePreview(resource Resource.Instance, receiver Object.Instance, receiver_func string, userdata any)
Queue the 'resource' being edited for preview. Once the preview is ready, the 'receiver”s 'receiver_func' will be called. The 'receiver_func' must take the following four arguments: string path, graphics.gd/classdb/Texture2D preview, graphics.gd/classdb/Texture2D thumbnail_preview, any userdata. 'userdata' can be anything, and will be returned when 'receiver_func' is called.
Note: If it was not possible to create the preview the '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 'path' for preview. Once the preview is ready, the 'receiver”s 'receiver_func' will be called. The 'receiver_func' must take the following four arguments: string path, graphics.gd/classdb/Texture2D preview, graphics.gd/classdb/Texture2D thumbnail_preview, any userdata. 'userdata' can be anything, and will be returned when 'receiver_func' is called.
Note: If it was not possible to create the preview the 'receiver_func' will still be called, but the preview will be null.
func (Instance) RemovePreviewGenerator ¶
func (self Instance) RemovePreviewGenerator(generator EditorResourcePreviewGenerator.Instance)
Removes a custom preview generator.
Source Files