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.

Sign up for GitHub

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

Jump to bottom

[3.x] GLTF imports & exports material texture filters #66856

Merged
merged 1 commit into from
Oct 4, 2022
Merged

[3.x] GLTF imports & exports material texture filters #66856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions modules/gltf/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ def get_doc_classes():
"GLTFSpecGloss",
"GLTFState",
"GLTFTexture",
"GLTFTextureSampler",
"PackedSceneGLTF",
]

Expand Down
13 changes: 13 additions & 0 deletions modules/gltf/doc_classes/GLTFState.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,12 @@
<description>
</description>
</method>
<method name="get_texture_samplers">
<return type="Array" />
<description>
Retrieves the array of texture samplers that are used by the textures contained in the GLTF.
</description>
</method>
<method name="get_textures">
<return type="Array" />
<description>
Expand Down Expand Up @@ -173,6 +179,13 @@
<description>
</description>
</method>
<method name="set_texture_samplers">
<return type="void" />
<argument index="0" name="texture_samplers" type="Array" />
<description>
Sets the array of texture samplers that are used by the textures contained in the GLTF.
</description>
</method>
<method name="set_textures">
<return type="void" />
<argument index="0" name="textures" type="Array" />
Expand Down
3 changes: 3 additions & 0 deletions modules/gltf/doc_classes/GLTFTexture.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
<methods>
</methods>
<members>
<member name="sampler" type="int" setter="set_sampler" getter="get_sampler" default="-1">
ID of the texture sampler to use when sampling the image. If -1, then the default texture sampler is used (linear filtering, and repeat wrapping in both axes).
</member>
<member name="src_image" type="int" setter="set_src_image" getter="get_src_image" default="0">
</member>
</members>
Expand Down
29 changes: 29 additions & 0 deletions modules/gltf/doc_classes/GLTFTextureSampler.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFTextureSampler" inherits="Resource" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Represents a GLTF texture sampler
</brief_description>
<description>
Represents a texture sampler as defined by the base GLTF spec. Texture samplers in GLTF specify how to sample data from the texture's base image, when rendering the texture on an object.
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="mag_filter" type="int" setter="set_mag_filter" getter="get_mag_filter" default="9729">
Texture's magnification filter, used when the texture appears larger on screen than the source image.
</member>
<member name="min_filter" type="int" setter="set_min_filter" getter="get_min_filter" default="9987">
Texture's minification filter, used when the texture appears smaller on screen than the source image.
</member>
<member name="wrap_s" type="int" setter="set_wrap_s" getter="get_wrap_s" default="10497">
Wrapping mode to use for S-axis (horizontal) texture coordinates.
</member>
<member name="wrap_t" type="int" setter="set_wrap_t" getter="get_wrap_t" default="10497">
Wrapping mode to use for T-axis (vertical) texture coordinates.
</member>
</members>
<constants>
</constants>
</class>
178 changes: 151 additions & 27 deletions modules/gltf/gltf_document.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,26 +131,26 @@ Error GLTFDocument::serialize(Ref<GLTFState> state, Node *p_root, const String &
return Error::FAILED;
}

/* STEP 7 SERIALIZE ANIMATIONS */
err = _serialize_animations(state);
/* STEP 7 SERIALIZE TEXTURE SAMPLERS */
err = _serialize_texture_samplers(state);
if (err != OK) {
return Error::FAILED;
}

/* STEP 8 SERIALIZE ACCESSORS */
err = _encode_accessors(state);
/* STEP 8 SERIALIZE ANIMATIONS */
err = _serialize_animations(state);
if (err != OK) {
return Error::FAILED;
}

/* STEP 9 SERIALIZE IMAGES */
err = _serialize_images(state, p_path);
/* STEP 9 SERIALIZE ACCESSORS */
err = _encode_accessors(state);
if (err != OK) {
return Error::FAILED;
}

/* STEP 10 SERIALIZE TEXTURES */
err = _serialize_textures(state);
/* STEP 10 SERIALIZE IMAGES */
err = _serialize_images(state, p_path);
if (err != OK) {
return Error::FAILED;
}
Expand All @@ -159,43 +159,43 @@ Error GLTFDocument::serialize(Ref<GLTFState> state, Node *p_root, const String &
state->buffer_views.write[i]->buffer = 0;
}

/* STEP 11 SERIALIZE BUFFER VIEWS */
/* STEP 12 SERIALIZE BUFFER VIEWS */
err = _encode_buffer_views(state);
if (err != OK) {
return Error::FAILED;
}

/* STEP 12 SERIALIZE NODES */
/* STEP 13 SERIALIZE NODES */
err = _serialize_nodes(state);
if (err != OK) {
return Error::FAILED;
}

/* STEP 13 SERIALIZE SCENE */
/* STEP 15 SERIALIZE SCENE */
err = _serialize_scenes(state);
if (err != OK) {
return Error::FAILED;
}

/* STEP 14 SERIALIZE SCENE */
/* STEP 16 SERIALIZE SCENE */
err = _serialize_lights(state);
if (err != OK) {
return Error::FAILED;
}

/* STEP 15 SERIALIZE EXTENSIONS */
/* STEP 17 SERIALIZE EXTENSIONS */
err = _serialize_extensions(state);
if (err != OK) {
return Error::FAILED;
}

/* STEP 16 SERIALIZE VERSION */
/* STEP 18 SERIALIZE VERSION */
err = _serialize_version(state);
if (err != OK) {
return Error::FAILED;
}

/* STEP 17 SERIALIZE FILE */
/* STEP 19 SERIALIZE FILE */
err = _serialize_file(state, p_path);
if (err != OK) {
return Error::FAILED;
Expand Down Expand Up @@ -2946,7 +2946,7 @@ Error GLTFDocument::_serialize_images(Ref<GLTFState> state, const String &p_path

ERR_CONTINUE(state->images[i].is_null());

Ref<Image> image = state->images[i]->get_data();
Ref<Image> image = state->images[i];
ERR_CONTINUE(image.is_null());

if (p_path.to_lower().ends_with("glb")) {
Expand Down Expand Up @@ -3151,11 +3151,7 @@ Error GLTFDocument::_parse_images(Ref<GLTFState> state, const String &p_base_pat
continue;
}

Ref<ImageTexture> t;
t.instance();
t->create_from_image(img);

state->images.push_back(t);
state->images.push_back(img);
}

print_verbose("glTF: Total images: " + itos(state->images.size()));
Expand All @@ -3174,6 +3170,11 @@ Error GLTFDocument::_serialize_textures(Ref<GLTFState> state) {
Ref<GLTFTexture> t = state->textures[i];
ERR_CONTINUE(t->get_src_image() == -1);
d["source"] = t->get_src_image();

GLTFTextureSamplerIndex sampler_index = t->get_sampler();
if (sampler_index != -1) {
d["sampler"] = sampler_index;
}
textures.push_back(d);
}
state->json["textures"] = textures;
Expand All @@ -3195,32 +3196,149 @@ Error GLTFDocument::_parse_textures(Ref<GLTFState> state) {
Ref<GLTFTexture> t;
t.instance();
t->set_src_image(d["source"]);
if (d.has("sampler")) {
t->set_sampler(d["sampler"]);
} else {
t->set_sampler(-1);
}
state->textures.push_back(t);

// Create and cache the texture used in the engine
Ref<ImageTexture> imgTex;
imgTex.instance();
imgTex->create_from_image(state->images[t->get_src_image()]);

// Set texture filter and repeat based on sampler settings
const Ref<GLTFTextureSampler> sampler = _get_sampler_for_texture(state, t->get_sampler());
Texture::Flags flags = sampler->get_texture_flags();
imgTex->set_flags(flags);

state->texture_cache.insert(i, imgTex);
}

return OK;
}

GLTFTextureIndex GLTFDocument::_set_texture(Ref<GLTFState> state, Ref<Texture> p_texture) {
ERR_FAIL_COND_V(p_texture.is_null(), -1);
ERR_FAIL_COND_V(p_texture->get_data().is_null(), -1);

// Create GLTF data structures for the new texture
Ref<GLTFTexture> gltf_texture;
gltf_texture.instance();
ERR_FAIL_COND_V(p_texture->get_data().is_null(), -1);
GLTFImageIndex gltf_src_image_i = state->images.size();
state->images.push_back(p_texture);

state->images.push_back(p_texture->get_data());

GLTFTextureSamplerIndex gltf_sampler_i = _set_sampler_for_mode(state, p_texture->get_flags());

gltf_texture->set_src_image(gltf_src_image_i);
gltf_texture->set_sampler(gltf_sampler_i);

GLTFTextureIndex gltf_texture_i = state->textures.size();
state->textures.push_back(gltf_texture);
state->texture_cache[gltf_texture_i] = p_texture;
return gltf_texture_i;
}

Ref<Texture> GLTFDocument::_get_texture(Ref<GLTFState> state, const GLTFTextureIndex p_texture) {
ERR_FAIL_INDEX_V(p_texture, state->textures.size(), Ref<Texture>());
const GLTFImageIndex image = state->textures[p_texture]->get_src_image();
return state->texture_cache[p_texture];
}

GLTFTextureSamplerIndex GLTFDocument::_set_sampler_for_mode(Ref<GLTFState> state, uint32_t p_mode) {
for (int i = 0; i < state->texture_samplers.size(); ++i) {
if (state->texture_samplers[i]->get_texture_flags() == p_mode) {
return i;
}
}

GLTFTextureSamplerIndex gltf_sampler_i = state->texture_samplers.size();
Ref<GLTFTextureSampler> gltf_sampler;
gltf_sampler.instance();
gltf_sampler->set_texture_flags(p_mode);
state->texture_samplers.push_back(gltf_sampler);
return gltf_sampler_i;
}

Ref<GLTFTextureSampler> GLTFDocument::_get_sampler_for_texture(Ref<GLTFState> state, const GLTFTextureIndex p_texture) {
ERR_FAIL_INDEX_V(p_texture, state->textures.size(), Ref<Texture>());
const GLTFTextureSamplerIndex sampler = state->textures[p_texture]->get_sampler();

if (sampler == -1) {
return state->default_texture_sampler;
} else {
ERR_FAIL_INDEX_V(sampler, state->texture_samplers.size(), Ref<GLTFTextureSampler>());

return state->texture_samplers[sampler];
}
}

Error GLTFDocument::_serialize_texture_samplers(Ref<GLTFState> state) {
if (!state->texture_samplers.size()) {
return OK;
}

Array samplers;
for (int32_t i = 0; i < state->texture_samplers.size(); ++i) {
Dictionary d;
Ref<GLTFTextureSampler> s = state->texture_samplers[i];
d["magFilter"] = s->get_mag_filter();
d["minFilter"] = s->get_min_filter();
d["wrapS"] = s->get_wrap_s();
d["wrapT"] = s->get_wrap_t();
samplers.push_back(d);
}
state->json["samplers"] = samplers;

return OK;
}

Error GLTFDocument::_parse_texture_samplers(Ref<GLTFState> state) {
state->default_texture_sampler.instance();
state->default_texture_sampler->set_min_filter(GLTFTextureSampler::FilterMode::LINEAR_MIPMAP_LINEAR);
state->default_texture_sampler->set_mag_filter(GLTFTextureSampler::FilterMode::LINEAR);
state->default_texture_sampler->set_wrap_s(GLTFTextureSampler::WrapMode::REPEAT);
state->default_texture_sampler->set_wrap_t(GLTFTextureSampler::WrapMode::REPEAT);

if (!state->json.has("samplers")) {
return OK;
}

const Array &samplers = state->json["samplers"];
for (int i = 0; i < samplers.size(); ++i) {
const Dictionary &d = samplers[i];

Ref<GLTFTextureSampler> sampler;
sampler.instance();

if (d.has("minFilter")) {
sampler->set_min_filter(d["minFilter"]);
} else {
sampler->set_min_filter(GLTFTextureSampler::FilterMode::LINEAR_MIPMAP_LINEAR);
}
if (d.has("magFilter")) {
sampler->set_mag_filter(d["magFilter"]);
} else {
sampler->set_mag_filter(GLTFTextureSampler::FilterMode::LINEAR);
}

ERR_FAIL_INDEX_V(image, state->images.size(), Ref<Texture>());
if (d.has("wrapS")) {
sampler->set_wrap_s(d["wrapS"]);
} else {
sampler->set_wrap_s(GLTFTextureSampler::WrapMode::REPEAT);
}

if (d.has("wrapT")) {
sampler->set_wrap_t(d["wrapT"]);
} else {
sampler->set_wrap_t(GLTFTextureSampler::WrapMode::REPEAT);
}

return state->images[image];
state->texture_samplers.push_back(sampler);
}

return OK;
}

Error GLTFDocument::_serialize_materials(Ref<GLTFState> state) {
Expand Down Expand Up @@ -6645,13 +6763,19 @@ Error GLTFDocument::parse(Ref<GLTFState> state, String p_path, bool p_read_binar
return Error::FAILED;
}

/* PARSE TEXTURE SAMPLERS */
err = _parse_texture_samplers(state);
if (err != OK) {
return Error::FAILED;
}

/* PARSE TEXTURES */
err = _parse_textures(state);
if (err != OK) {
return Error::FAILED;
}

/* PARSE TEXTURES */
/* PARSE MATERIALS */
err = _parse_materials(state);
if (err != OK) {
return Error::FAILED;
Expand Down
Loading