EditorResourcePreviewGenerator

Documentation

Overview

Package EditorResourcePreviewGenerator provides methods for working with EditorResourcePreviewGenerator object instances.

Index

• type Advanced
• type Any
• type Implementation
• type Instance
  • func New() Instance
  • func (self Instance) AsEditorResourcePreviewGenerator() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type Interface

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
	AsEditorResourcePreviewGenerator() Instance
}

type Implementation

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance

type Instance [1]gdclass.EditorResourcePreviewGenerator

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

See [Interface] for methods that can be overridden by a [Class] that extends it.

%!(EXTRA string=EditorResourcePreviewGenerator)

var Nil Instance

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

func New

func New() Instance

func (Instance) AsEditorResourcePreviewGenerator

func (self Instance) AsEditorResourcePreviewGenerator() Instance

func (Instance) AsObject

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

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (*Instance) UnsafePointer

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

func (Instance) Virtual

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

type Interface

type Interface interface {
	//Returns [code]true[/code] if your generator supports the resource of type [param type].
	Handles(atype string) bool
	//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).
	//[param metadata] dictionary can be modified to store file-specific metadata that can be used in [method EditorResourceTooltipPlugin._make_tooltip_for_path] (like image size, sample length etc.).
	Generate(resource [1]gdclass.Resource, size Vector2i.XY, metadata map[any]any) [1]gdclass.Texture2D
	//Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method _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).
	//[param metadata] dictionary can be modified to store file-specific metadata that can be used in [method EditorResourceTooltipPlugin._make_tooltip_for_path] (like image size, sample length etc.).
	GenerateFromPath(path string, size Vector2i.XY, metadata map[any]any) [1]gdclass.Texture2D
	//If this function returns [code]true[/code], the generator will automatically generate the small previews from the normal preview texture generated by the methods [method _generate] or [method _generate_from_path].
	//By default, it returns [code]false[/code].
	GenerateSmallPreviewAutomatically() bool
	//If this function returns [code]true[/code], the generator will call [method _generate] or [method _generate_from_path] for small previews as well.
	//By default, it returns [code]false[/code].
	CanGenerateSmallPreview() bool
}