Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document support for importing KTX images in Importing images #8426

Merged
merged 1 commit into from
Nov 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions tutorials/assets_pipeline/exporting_3d_scenes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ Exporting 3D scenes
Overview
--------

In Godot it is possible to export 3D scenes as a glTF 2.0 file. You can
In Godot, it is possible to export 3D scenes as a glTF 2.0 file. You can
export as a glTF binary (``.glb`` file) or glTF embedded with textures
(``gltf`` + ``.bin`` + textures). This allows you to create scenes in Godot,
such as a CSG mesh blockout for a level, export it to clean it up in a
program such as Blender, and then bring it back into Godot.

.. note::
.. note::

Only Blender 2.83 and newer can import glTF files exported by Godot.

Expand All @@ -28,3 +28,9 @@ There are several limitations with glTF export.
* No support for exporting particles since their implementation varies across engines.
* ShaderMaterials cannot be exported.
* No support for exporting 2D scenes.

.. seealso::

3D scenes can be saved at runtime using
:ref:`runtime file loading and saving <doc_runtime_file_loading_and_saving_3d_scenes>`,
including from an exported project.
6 changes: 6 additions & 0 deletions tutorials/assets_pipeline/importing_3d_scenes/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,9 @@ dialog, and inherited scenes.
model_export_considerations
node_type_customization
import_configuration

.. seealso::

3D scenes can be loaded at runtime using
:ref:`runtime file loading and saving <doc_runtime_file_loading_and_saving_3d_scenes>`,
including from an exported project.
6 changes: 6 additions & 0 deletions tutorials/assets_pipeline/importing_audio_samples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -304,3 +304,9 @@ reducing their size greatly and ensuring correct trimming.

As you can see above, sound effects become much larger in file size with reverb
added.

.. seealso::

Audio samples can be loaded and saved at runtime using
:ref:`runtime file loading and saving <doc_runtime_file_loading_and_saving_audio_video_files>`,
including from an exported project.
9 changes: 9 additions & 0 deletions tutorials/assets_pipeline/importing_images.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ Godot can import the following image formats:
- DirectDraw Surface (``.dds``)
- If mipmaps are present in the texture, they will be loaded directly.
This can be used to achieve effects using custom mipmaps.
- Khronos Texture (``.ktx``)
- Decoding is done using `libktx <https://github.com/KhronosGroup/KTX-Software>`__.
Only supports 2D images. Cubemaps, texture arrays and de-padding are not supported.
- OpenEXR (``.exr``)
- Supports HDR (highly recommended for panorama skies).
- Radiance HDR (``.hdr``)
Expand Down Expand Up @@ -538,3 +541,9 @@ worth exploring:
- When working with 3D models using a low-poly style and plain colors, you can
rely on vertex colors instead of textures to represent colors on the model's
surfaces.

.. seealso::

Images can be loaded and saved at runtime using
:ref:`runtime file loading and saving <doc_runtime_file_loading_and_saving_images>`,
including from an exported project.
6 changes: 6 additions & 0 deletions tutorials/io/runtime_file_loading_and_saving.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ several helper methods to decode/encode series of bytes to integers, floats,
strings and more. These PackedByteArray methods have names that start with
``decode_`` and ``encode_``. See also :ref:`doc_binary_serialization_api`.

.. _doc_runtime_file_loading_and_saving_images:

Images
------

Expand Down Expand Up @@ -118,6 +120,8 @@ Example of loading an image and displaying it in a :ref:`class_TextureRect` node
# Save the converted ImageTexture to a PNG image.
$TextureRect.texture.get_image().save_png("/path/to/file.png")

.. _doc_runtime_file_loading_and_saving_audio_video_files:

Audio/video files
-----------------

Expand Down Expand Up @@ -157,6 +161,8 @@ Example of loading an Ogg Theora video file in a :ref:`class_VideoStreamPlayer`
:ref:`AudioStreamWAV.save_to_wav <class_AudioStreamWAV_method_save_to_wav>`, which is useful
for procedurally generated audio or microphone recordings.

.. _doc_runtime_file_loading_and_saving_3d_scenes:

3D scenes
---------

Expand Down