diff options
| author | kobewi <kobewi4e@gmail.com> | 2022-07-17 23:55:46 +0200 |
|---|---|---|
| committer | kobewi <kobewi4e@gmail.com> | 2022-07-18 13:01:04 +0200 |
| commit | e8288ac9ab854da0efc147815cff798ac59c1504 (patch) | |
| tree | cbf68a60cc7edc385b5521260a29d96cf73ef91b /doc/classes | |
| parent | 1c6148aa86c4a3b8d5c292da69ffacc2f3a46eb8 (diff) | |
Clarify create_from_image() usage
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/ImageTexture.xml | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index e668e2e7fd..1ec5d19bb8 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -42,6 +42,14 @@ Returns the format of the texture, one of [enum Image.Format]. </description> </method> + <method name="set_image"> + <return type="void" /> + <argument index="0" name="image" type="Image" /> + <description> + Replaces the texture's data with a new [Image]. This will re-allocate new memory for the texture. + If you want to update the image, but don't need to change its paramters (format, size), use [method update] instead for better performance. + </description> + </method> <method name="set_size_override"> <return type="void" /> <argument index="0" name="size" type="Vector2" /> @@ -54,8 +62,8 @@ <argument index="0" name="image" type="Image" /> <description> Replaces the texture's data with a new [Image]. - [b]Note:[/b] The texture has to be initialized first with the [method create_from_image] method before it can be updated. The new image dimensions, format, and mipmaps configuration should match the existing texture's image configuration, otherwise it has to be re-created with the [method create_from_image] method. - Use this method over [method create_from_image] if you need to update the texture frequently, which is faster than allocating additional memory for a new texture each time. + [b]Note:[/b] The texture has to be created using [method create_from_image] or initialized first with the [method set_image] method before it can be updated. The new image dimensions, format, and mipmaps configuration should match the existing texture's image configuration. + Use this method over [method set_image] if you need to update the texture frequently, which is faster than allocating additional memory for a new texture each time. </description> </method> </methods> |