godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/ImageTexture.xml

95 lines
3.3 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Drop unused 'category' property from header We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2020-01-26 15:01:49 +00:00
<class name="ImageTexture" inherits="Texture" version="3.2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
A [Texture] based on an [Image].
</brief_description>
<description>
[DOCS] Review and improve 17 classes (#11890)
2017-10-09 10:49:12 +00:00
A [Texture] based on an [Image]. Can be created from an [Image] with [method create_from_image].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="create">
<return type="void">
</return>
<argument index="0" name="width" type="int">
</argument>
<argument index="1" name="height" type="int">
</argument>
<argument index="2" name="format" type="int" enum="Image.Format">
</argument>
<argument index="3" name="flags" type="int" default="7">
</argument>
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
Create a new [ImageTexture] with [code]width[/code] and [code]height[/code].
doc: Fix references to setters and misc formatting
2018-12-28 23:17:09 +00:00
[code]format[/code] is a value from [enum Image.Format], [code]flags[/code] is any combination of [enum Texture.Flags].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="create_from_image">
<return type="void">
</return>
<argument index="0" name="image" type="Image">
</argument>
<argument index="1" name="flags" type="int" default="7">
</argument>
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
Create a new [ImageTexture] from an [Image] with [code]flags[/code] from [enum Texture.Flags]. An sRGB to linear color space conversion can take place, according to [enum Image.Format].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_format" qualifiers="const">
<return type="int" enum="Image.Format">
</return>
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 02:15:43 +00:00
Returns the format of the [ImageTexture], one of [enum Image.Format].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="load">
ImageTexture.load returns an error code.
2018-05-12 14:53:45 +00:00
<return type="int" enum="Error">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
Load an [ImageTexture] from a file path.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_data">
<return type="void">
</return>
<argument index="0" name="image" type="Image">
</argument>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Sets the [Image] of this [ImageTexture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_size_override">
<return type="void">
</return>
<argument index="0" name="size" type="Vector2">
</argument>
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
Resizes the [ImageTexture] to the specified dimensions.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
<members>
doc: Fix parsing of self-closing XML tags Follow-up to #31925, `<member />` tags just before `</members>` would cause a parsing issue, and we'd never notice that we're no longer parsing members. Also added space before closing `/>`.
2019-09-24 11:34:03 +00:00
<member name="flags" type="int" setter="set_flags" getter="get_flags" override="true" default="7" />
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="lossy_quality" type="float" setter="set_lossy_storage_quality" getter="get_lossy_storage_quality" default="0.7">
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 10:34:26 +00:00
The storage quality for [constant STORAGE_COMPRESS_LOSSY].
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="storage" type="int" setter="set_storage" getter="get_storage" enum="ImageTexture.Storage" default="0">
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
The storage type (raw, lossy, or compressed).
</member>
</members>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="STORAGE_RAW" value="0" enum="Storage">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
[Image] data is stored raw and unaltered.
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="STORAGE_COMPRESS_LOSSY" value="1" enum="Storage">
doc: Fix references to setters and misc formatting
2018-12-28 23:17:09 +00:00
[Image] data is compressed with a lossy algorithm. You can set the storage quality with [member lossy_quality].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="STORAGE_COMPRESS_LOSSLESS" value="2" enum="Storage">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
[Image] data is compressed with a lossless algorithm.
</constant>
</constants>
</class>