diff options
Diffstat (limited to 'doc/classes/EditorResourcePreviewGenerator.xml')
| -rw-r--r-- | doc/classes/EditorResourcePreviewGenerator.xml | 50 |
1 files changed, 19 insertions, 31 deletions
diff --git a/doc/classes/EditorResourcePreviewGenerator.xml b/doc/classes/EditorResourcePreviewGenerator.xml index e935bf19fc..d8b4a86a97 100644 --- a/doc/classes/EditorResourcePreviewGenerator.xml +++ b/doc/classes/EditorResourcePreviewGenerator.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorResourcePreviewGenerator" inherits="Reference" version="4.0"> +<class name="EditorResourcePreviewGenerator" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Custom generator of previews. </brief_description> @@ -9,58 +9,46 @@ <tutorials> </tutorials> <methods> - <method name="can_generate_small_preview" qualifiers="virtual"> - <return type="bool"> - </return> + <method name="_can_generate_small_preview" qualifiers="virtual const"> + <return type="bool" /> <description> - If this function returns [code]true[/code], the generator will call [method generate] or [method generate_from_path] for small previews as well. + 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]. </description> </method> - <method name="generate" qualifiers="virtual"> - <return type="Texture2D"> - </return> - <argument index="0" name="from" type="Resource"> - </argument> - <argument index="1" name="size" type="Vector2"> - </argument> + <method name="_generate" qualifiers="virtual const"> + <return type="Texture2D" /> + <argument index="0" name="resource" type="Resource" /> + <argument index="1" name="size" type="Vector2i" /> <description> 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). </description> </method> - <method name="generate_from_path" qualifiers="virtual"> - <return type="Texture2D"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <argument index="1" name="size" type="Vector2"> - </argument> + <method name="_generate_from_path" qualifiers="virtual const"> + <return type="Texture2D" /> + <argument index="0" name="path" type="String" /> + <argument index="1" name="size" type="Vector2i" /> <description> - Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method generate]. + 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). </description> </method> - <method name="generate_small_preview_automatically" qualifiers="virtual"> - <return type="bool"> - </return> + <method name="_generate_small_preview_automatically" qualifiers="virtual const"> + <return type="bool" /> <description> - 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]. + 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]. </description> </method> - <method name="handles" qualifiers="virtual"> - <return type="bool"> - </return> - <argument index="0" name="type" type="String"> - </argument> + <method name="_handles" qualifiers="virtual const"> + <return type="bool" /> + <argument index="0" name="type" type="String" /> <description> Returns [code]true[/code] if your generator supports the resource of type [code]type[/code]. </description> </method> </methods> - <constants> - </constants> </class> |