KHR_texture_transform

extensions/2.0/Khronos/KHR_texture_transform/README.md

@@ -0,0 +1,102 @@
+# KHR_texture_transform
+
+## Contributors
+
+* Steven Vergenz, Microsoft ([[email protected]](mailto:[email protected]))
+
+## Status
+
+Draft
+
+## Dependencies
+
+Written against the glTF 2.0 spec.
+
+## Overview
+
+Many techniques can be used to optimize resource usage for a 3d scene. Chief among them is the ability to minimize the number of textures the GPU must load. To achieve this, many engines encourage packing many objects' low-resolution textures into a single large texture atlas. The region of the resulting atlas that corresponds with each object is then defined by vertical and horizontal offsets, and the width and height of the region.
+
+To support this use case, this extension adds `offset`, `rotation`, and `scale` properties to textureInfo structures. These properties would typically be implemented as an affine transform on the UV coordinates. In GLSL:
+
+```glsl
+varying in vec2 Uv;
+
+uniform vec2 Offset, Scale;
+uniform float Rotation;
+
+mat3 translation = mat3(1,0,0, 0,1,0, Offset.x, Offset.y, 1);
+mat3 rotation = mat3(
+    cos(Rotation), sin(Rotation), 0,
+   -sin(Rotation), cos(Rotation), 0,
+                0,             0, 1
+);
+mat3 scale = mat3(Scale.x,0,0, 0,Scale.y,0, 0,0,1);
+
+mat3 matrix = translation * rotation * scale;
+vec2 uvTransformed = ( matrix * vec3(Uv.xy, 1) ).xy;
+```
+
+This is equivalent to Unity's `Material#SetTextureOffset` and `Material#SetTextureScale`, or Three.js's `Texture#offset` and `Texture#repeat`. UV rotation is not widely supported as of today, but is included here for forward compatibility.
+
+## glTF Schema Updates
+
+The `KHR_texture_transform` extension may be defined on `textureInfo` structures. It may contain the following properties:
+
+| Name       | Type       | Default      | Description
+|------------|------------|--------------|---------------------------------
+| `offset`   | `array[2]` | `[0.0, 0.0]` | The offset of the UV coordinate origin as a factor of the texture dimensions.
+| `rotation` | `number`   | `0.0`        | Rotate the UVs by this many radians counter-clockwise around the origin. This is equivalent to a similar rotation of the image clockwise.
+| `scale`    | `array[2]` | `[1.0, 1.0]` | The scale factor applied to the components of the UV coordinates.
+| `texCoord` | `integer`  |              | Overrides the textureInfo texCoord value if supplied, and if this extension is supported.
+
+Though this extension's values are unbounded, they will only produce sane results if the texture sampler's `wrap` mode is `REPEAT`, or if the result of the final UV transformation is within the range [0, 1] (i.e. negative scale settings and correspondingly positive offsets).
+
+> **Implementation Note**: For maximum compatibility, it is recommended that exporters generate UV coordinate sets both with and without transforms applied, use the post-transform set in the texture `texCoord` field, then the pre-transform set with this extension. This way, if the extension is not supported by the consuming engine, the model still renders correctly. Including both will increase the size of the model, so if including the fallback UV set is too burdensome, either add this extension to `extensionsRequired` or use the same texCoord value in both places.
+
+### JSON Schema
+
+[KHR_texture_transform.textureInfo.schema.json](schema/KHR_texture_transform.textureInfo.schema.json)
+
+### Example JSON
+
+This example utilizes only the lower left quadrant of the source image, rotated clockwise 90°.
+
+```json
+{
+  "materials": [{
+    "emissiveTexture": {
+      "index": 0,
+      "extensions": {
+        "KHR_texture_transform": {
+          "offset": [0, 1],
+          "rotation": 1.57079632679,
+          "scale": [0.5, 0.5]
+        }
+      }
+    }
+  }]
+}
+```
+
+This example inverts the T axis, effectively defining a bottom-left origin.
+
+```json
+{
+  "materials": [{
+    "emissiveTexture": {
+      "index": 0,
+      "extensions": {
+        "KHR_texture_transform": {
+          "offset": [0, 1],
+          "scale": [1, -1]
+        }
+      }
+    }
+  }]
+}
+```
+
+## Known Implementations
+
+* [UnityGLTF](https://github.com/KhronosGroup/UnityGLTF)
+* [Babylon.js](https://www.babylonjs.com/)

extensions/2.0/Khronos/KHR_texture_transform/schema/KHR_texture_transform.textureInfo.schema.json

@@ -0,0 +1,42 @@
+{
+    "$schema" : "http://json-schema.org/draft-04/schema",
+    "title" : "KHR_texture_transform textureInfo extension",
+    "type" : "object",
+    "description": "glTF extension that enables shifting and scaling UV coordinates on a per-texture basis",
+    "allOf": [ { "$ref": "glTFProperty.schema.json" } ],
+    "properties" : {
+        "offset": {
+            "type": "array",
+            "description": "The offset of the UV coordinate origin as a factor of the texture dimensions.",
+            "items": {
+                "type": "number"
+            },
+            "minItems": 2,
+            "maxItems": 2,
+            "default": [ 0.0, 0.0 ]
+        },
+        "rotation": {
+            "type": "number",
+            "description": "Rotate the UVs by this many radians counter-clockwise around the origin.",
+            "default": 0.0
+        },
+        "scale": {
+            "type": "array",
+            "description": "The scale factor applied to the components of the UV coordinates.",
+            "items": {
+                "type": "number"
+            },
+            "minItems": 2,
+            "maxItems": 2,
+            "default": [ 1.0, 1.0 ]
+        },
+        "texCoord": {
+            "type": "integer",
+            "description": "Overrides the textureInfo texCoord value if supplied, and if this extension is supported.",
+            "minimum": 0
+        },
+        "extensions": { },
+        "extras": { }
+    },
+    "additionalProperties" : false
+}

extensions/README.md

@@ -34,7 +34,7 @@ _Draft Khronos extensions are not ratified yet._
 
 # About glTF Extensions
 
-glTF extensions extend the base glTF model format.  Extensions can introduce new properties (including properties that reference external data, and the extension can define the format of those data), new parameter semantics, reserved IDs, and new container formats.  Extensions are written against a specific version of glTF and may be promoted to core glTF in a later glTF version. 
+glTF extensions extend the base glTF model format.  Extensions can introduce new properties (including properties that reference external data, and the extension can define the format of those data), new parameter semantics, reserved IDs, and new container formats.  Extensions are written against a specific version of glTF and may be promoted to core glTF in a later glTF version.
 
 ## Extension Mechanics
 
@@ -78,7 +78,7 @@ This allows an engine to quickly determine if it supports the extensions needed
 
 To create a new extension, use the [extension template](Template.md) and open a pull request into this repo.  Make sure to add the extension to the glTF Extension Registry (top of this file).
 
-If lack of extension support prevents proper geometry loading, extension specification _must_ state that (and such extension must be mentioned in `extensionsRequired` top-level glTF property).  
+If lack of extension support prevents proper geometry loading, extension specification _must_ state that (and such extension must be mentioned in `extensionsRequired` top-level glTF property).
 
 Extensions start as a vendor extension, then can become a multi-vendor extensions if there are multiple implementations, and can become a ratified Khronos extension (the multi-vendor extension is an optional step).