Haoyu Qiu
1230169ad1
Fix broken links in Class Reference
...
(cherry picked from commit b1153f8829
)
2021-12-10 17:30:31 +01:00
Manolis Papadeas
8c59dbda33
Fix link to the supported image formats in the Image class
...
It previously linked to this page which doesn't exist. https://docs.godotengine.org/en/latest/getting_started/workflow/assets/importing_images.html#supported-image-formats
Now, it should link here: https://docs.godotengine.org/en/latest/tutorials/assets_pipeline/importing_images.html#supported-image-formats
(cherry picked from commit c01c4c687b
)
2021-12-07 09:14:31 +01:00
Hugo Locurcio
059ba23f72
Document `Image.FORMAT_R8` stores in alpha channel instead in GLES2
2021-10-25 16:52:58 +02:00
Hugo Locurcio
9aee1a3992
Document `Image.generate_mipmaps()` always running on the main thread
...
(cherry picked from commit 30a88f464b
)
2021-09-14 13:41:26 +02:00
Rémi Verschelde
f0b37b1519
doc: Point URLs to 3.4 version of the online docs
2021-08-12 17:08:10 +02:00
Rémi Verschelde
f5836b40d4
doc: Use self-closing tags for `return` and `argument`
...
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5
)
2021-08-03 10:20:19 +02:00
Hugo Locurcio
7e3c0a0c1f
Document `Image.save_exr()` only being available in editor builds
...
(cherry picked from commit a1784c64b4
)
2021-07-28 15:35:52 +02:00
Nicholas Huelin
bd8747f7f1
Fix miscellaneous doc typos and inconsistencies
...
This pull request fixes an assortment of typos, improves conciseness, and enhances clarity.
(cherry picked from commit 9787e631aa
)
2021-07-24 01:00:37 +02:00
Rémi Verschelde
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
Rémi Verschelde
015973df04
doc: Make all tutorial links point to 3.3 branch of docs
2021-03-26 10:43:43 +01:00
Paul Joannon
596169d7df
class reference proofreading
...
(cherry picked from commit 8455e901f3
)
2021-03-26 09:49:07 +01:00
Rémi Verschelde
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
Theogen Ratkin
8f6a6ac8d0
Add interpolation parameter to resize_to_po2()
...
Image::resize_to_po2() now takes an optional p_interpolation parameter
that it passes directly to resize() with default value INTERPOLATE_BILINEAR.
GLES2: call resize_to_po2() with interpolate argument
Call resize_to_po2() in GLES2 rasterizer storage with either
INTERPOLATE_BILINEAR or INTERPOLATE_NEAREST depending on TEXTURE_FLAG_FILTER.
This avoids filtering issues with non power of two pixel art textures.
See #44379
2020-12-18 14:02:38 -04:00
Andrii Doroshenko (Xrayez)
2edd489f83
Describe `ImageTexture`, `Image` creation and usage
...
Ported from commit 0ee88d6705
.
2020-11-17 18:06:52 +02:00
Hugo Locurcio
7db872b55a
Add `Image.load_bmp_from_buffer()` for run-time BMP image loading
...
This partially addresses
https://github.com/godotengine/godot-proposals/issues/676 .
(cherry picked from commit 0209e3790e
)
2020-11-11 15:30:55 +01:00
Rémi Verschelde
4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch
2020-10-19 16:10:01 +02:00
Ebrahim Ebrahim
508dde662a
Clarify get_data Image method
...
(cherry picked from commit b9764b6109
)
2020-09-14 11:00:50 +02:00
Rémi Verschelde
fcce1ca8c4
doc: Sync classref with current source
2020-07-06 14:32:13 +02:00
31
1b58f94296
Fix Image.create_from_data use_mipmaps doc
...
The Image.create_from_data doc describes the "use_mipmaps" argument as a
way to generate mipmaps, but this method only allocates and loads data.
This can cause confusion, where this function reads more or less data
than expected. Update the doc to be more specific that create_from_data
is loading the mipmaps from the raw data.
(cherry picked from commit 09b324b5b6
)
2020-06-15 14:34:35 +02:00
Rémi Verschelde
acb83db1d1
doc: Sync classref with current source
2020-05-25 17:00:22 +02:00
Hugo Locurcio
be56ec9e65
Document the formats supported by `Image.load()`
...
This partially addresses #32166 .
(cherry picked from commit a26649de42
)
2020-05-01 10:56:58 +02:00
Hugo Locurcio
4f7296a869
Document image size limits
...
This closes #30238 .
(cherry picked from commit 5497cec7a1
)
2020-04-20 11:54:47 +02:00
Rémi Verschelde
2d20fc39aa
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 16:02:39 +01:00
Eric Rybicki
439e0027ec
Fix AtlasPacker ignoring semi-transparent pixels
...
Fixes #33106
2020-01-20 22:43:38 +01:00
clayjohn
46b5742159
Completed documentation for many visual nodes
2020-01-14 18:28:36 -08:00
Rémi Verschelde
4eff13d768
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
Tomasz Chabora
2bde99f790
Fix some small text mistakes
2019-11-08 23:31:29 +01:00
Rémi Verschelde
79918eca30
Merge pull request #33151 from thiagoamendola/doc_setpixelv
...
Add documentation for Image's set_pixelv method
2019-11-02 19:30:57 +01:00
Thiago Amendola
ecb4c70ed3
Add documentation for Image's set_pixelv method
2019-11-02 15:06:47 -03:00
PouleyKetchoupp
52e799b6d4
Code format for true/false/null to make documentation consistent
2019-11-02 12:14:15 +01:00
Rémi Verschelde
fdc2463a1b
Merge pull request #32150 from luzpaz/typos
...
Fix misc. source comment typos
2019-09-20 17:09:05 +02:00
luz.paz
91ecd7b6a6
Fix misc. source comment typos
...
Found using `codespell -q 3 -S ./thirdparty,*.po -L ang,ba,cas,dof,doubleclick,fave,hist,leapyear,lod,nd,numer,ois,paket,seeked,sinc,switchs,te,uint -D ~/Projects/codespell/codespell_lib/data/dictionary.txt `
2019-09-19 14:36:52 -04:00
Hugo Locurcio
46d71ee2a1
Improve the `Image.get_pixel()` and `Image.get_pixelv()` documentation
2019-09-15 21:57:35 +02:00
Rémi Verschelde
592909db16
doc: Sync classref with current source
2019-08-13 12:35:50 +02:00
Marc Gilleron
cd2de77b04
Add Image.save_exr()
2019-08-07 21:17:47 +01:00
Rémi Verschelde
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +02:00
Rémi Verschelde
c6cea6e9b3
doc: Add default values to all properties
...
Thanks to @bojidar-bg's impressive work in #29380 .
2019-06-30 13:58:07 +02:00
Hugo Locurcio
f7f6115f76
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-27 22:30:19 +02:00
Rémi Verschelde
bc82781f7d
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 13:49:36 +02:00
Rémi Verschelde
86ed7a9884
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
Maxime Leroy
f1e2324605
Adding details about `Image.lock()` function
2019-06-08 16:03:50 +02:00
Daw11
28bff3d1ad
Implement Lanczos image filter
2019-05-05 14:03:56 +02:00
Rémi Verschelde
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Tomasz Chabora
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +02:00
Rémi Verschelde
63d3a42f82
Merge pull request #27465 from neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough
...
EditorHelp: Improve enum ref resolving and add constant ref support
2019-04-05 15:19:21 +02:00
Rémi Verschelde
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Ignacio Etcheverry
d80bc5cbba
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 23:47:35 +01:00
Rémi Verschelde
f614f15506
doc: Misc formatting fixes
2019-02-10 13:30:48 +01:00
Rémi Verschelde
cc0842f9a6
Prevent upscaled SVG from exceeding Image bounds
...
Also expose Image MAX_WIDTH and MAX_HEIGHT.
Fixes #24455 .
2019-01-28 16:00:15 +01:00