summaryrefslogtreecommitdiff
path: root/doc/classes/Image.xml
AgeCommit message (Collapse)Author
2021-11-23Add Image::fill_rect methodkleonc
2021-11-15Replace Godot docs URL with `$DOCS_URL` in XML class referenceRémi Verschelde
2021-10-06doc: Update links to latest documentation after content reorganizationRémi Verschelde
2021-08-22Document `Image.generate_mipmaps()` always running on the main threadHugo Locurcio
2021-07-30doc: Use self-closing tags for `return` and `argument`Rémi Verschelde
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.
2021-07-28Merge pull request #50677 from Calinou/doc-image-save-exr-editor-onlyRémi Verschelde
Document `Image.save_exr()` only being available in editor builds
2021-07-22Fix miscellaneous doc typos and inconsistenciesNicholas Huelin
This pull request fixes an assortment of typos, improves conciseness, and enhances clarity.
2021-07-21Document `Image.save_exr()` only being available in editor buildsHugo Locurcio
2021-06-18Better format arguments in variant parserMichael Alexsander Silva Dias
2021-04-16Import: Cleanup and optimize etcpak compression methodRémi Verschelde
Avoid unnecessary allocation of temporary buffers for each mip, and creates only one Image with the compressed data. Also renames variable and reorders code for clarity. Clarify that squish is now only used for decompression. Documented which formats can be decompressed in Image.
2021-03-19class reference proofreadingPaul Joannon
2021-02-19doc: Sync classref with current sourceRémi Verschelde
And fix various bogus bindings following previous PRs.
2020-12-29Consistently use normal_mapMarcel Admiraal
2020-12-18Add interpolation parameter to resize_to_po2()Theogen Ratkin
Image::resize_to_po2() now takes an optional p_interpolation parameter that it passes directly to resize() with default value INTERPOLATE_BILINEAR.
2020-12-10Image: Rename PVRTC{2,4} to PVRTC1_{2,4}, drop COMPRESS_PVRTC2Rémi Verschelde
We haven't had a proper implementation for COMPRESS_PVRTC2 (which is PVRTC1 2-bpp) in years, so let's drop it instead of keeping a compress type which doesn't work. The other enum values were renamed to clarify that our PVRTC2 and PVRTC4 are respectively PVRTC1 2-bpp and PVRTC1 4-bpp. PVRTC2 2-bpp and 4-bpp are not implemented yet.
2020-11-21Use Vector2i instead of Vector2 for Image get_pixelv and set_pixelvAaron Franke
Co-authored-by: Andrii Doroshenko <xrayez@gmail.com>
2020-11-17Describe `ImageTexture`, `Image` creation and usageAndrii Doroshenko (Xrayez)
2020-10-20Add `Image.load_bmp_from_buffer()` for run-time BMP image loadingHugo Locurcio
This partially addresses https://github.com/godotengine/godot-proposals/issues/676.
2020-09-11Clarify get_data Image methodEbrahim Ebrahim
2020-07-01Environment: Refactor code for readability + moreRémi Verschelde
- Makes all boolean setters/getters consistent. - Fixes bug where `glow_hdr_bleed_scale` was not used. - Split CameraEffects to their own source file. - Reorder all Environment method and properties declarations, definitions and bindings to be consistent with each other and with the order of property bindings. - Bind missing enum values added with SDFGI. - Remove unused SDFGI enhance_ssr boolean. - Sync doc changes after SDFGI merge and other misc changes.
2020-06-13Fix Image.create_from_data use_mipmaps doc31
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.
2020-06-04doc: Sync classref with current sourceRémi Verschelde
2020-05-16Remove HQ2X and the `Image.expand_2x_hq2x()` methodHugo Locurcio
As of Godot 3.0, HQ2X is no longer used to upscale the editor theme and icons on hiDPI displays, which limited its effective uses. HQ2X was also used to upscale the project theme when the "Use Hidpi" project setting was enabled, but results were often less than ideal. The new StyleBoxFlat and SVG support also make HQ2X less important to have as a core feature. This decreases binary sizes slightly (-150 KB on most platforms, -212 KB on WebAssembly release). This partially addresses #12419.
2020-04-29Document the formats supported by `Image.load()`Hugo Locurcio
This partially addresses #32166.
2020-04-17Document image size limitsHugo Locurcio
This closes #30238.
2020-04-03doc: Sync classref with current sourceRémi Verschelde
2020-02-18doc: Sync classref with current sourceRémi Verschelde
Handle removal of Pool*Array types and other recent changes.
2020-02-12doc: Sync classref with current sourceRémi Verschelde
Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-01-31Update docs to version 4.0clayjohn
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
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-20Fix AtlasPacker ignoring semi-transparent pixelsEric Rybicki
Fixes #33106
2020-01-14Completed documentation for many visual nodesclayjohn
2019-12-06doc: Markup fixes for enums and constantsRémi Verschelde
2019-11-08Fix some small text mistakesTomasz Chabora
2019-11-02Merge pull request #33151 from thiagoamendola/doc_setpixelvRémi Verschelde
Add documentation for Image's set_pixelv method
2019-11-02Add documentation for Image's set_pixelv methodThiago Amendola
2019-11-02Code format for true/false/null to make documentation consistentPouleyKetchoupp
2019-09-20Merge pull request #32150 from luzpaz/typosRémi Verschelde
Fix misc. source comment typos
2019-09-19Fix misc. source comment typosluz.paz
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-15Improve the `Image.get_pixel()` and `Image.get_pixelv()` documentationHugo Locurcio
2019-08-13doc: Sync classref with current sourceRémi Verschelde
2019-08-07Add Image.save_exr()Marc Gilleron
2019-07-15doc: Sync classref with current sourceRémi Verschelde
2019-06-30doc: Add default values to all propertiesRémi Verschelde
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- 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-27doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinksRémi Verschelde
2019-06-27doc: Complete and harmonize all _MAX constant descriptionsRémi Verschelde
2019-06-08Adding details about `Image.lock()` functionMaxime Leroy
2019-05-05Implement Lanczos image filterDaw11
2019-04-22Merge pull request #28125 from KoBeWi/code_true_codeRémi Verschelde
Consistently wrap booleans in [code]