Documentation ¶
Index ¶
- Constants
- Variables
- func DenormalizeByte(v int8) float32
- func DenormalizeRGB(v [3]uint8) [3]float32
- func DenormalizeRGB64(v [3]uint16) [3]float32
- func DenormalizeRGBA(v [4]uint8) [4]float32
- func DenormalizeRGBA64(v [4]uint16) [4]float32
- func DenormalizeShort(v int16) float32
- func DenormalizeUbyte(v uint8) float32
- func DenormalizeUshort(v uint16) float32
- func Float(val float32) *float32
- func Index(i uint32) *uint32
- func NormalizeByte(v float32) int8
- func NormalizeRGB(v [3]float32) [3]uint8
- func NormalizeRGB64(v [3]float32) [3]uint16
- func NormalizeRGBA(v [4]float32) [4]uint8
- func NormalizeRGBA64(v [4]float32) [4]uint16
- func NormalizeShort(v float32) int16
- func NormalizeUbyte(v float32) uint8
- func NormalizeUshort(v float32) uint16
- func RegisterExtension(key string, f func([]byte) (interface{}, error))
- func Save(doc *Document, name string) error
- func SaveBinary(doc *Document, name string) error
- type Accessor
- type AccessorType
- type AlphaMode
- type Animation
- type AnimationSampler
- type Asset
- type Attribute
- type Buffer
- type BufferView
- type Camera
- type Channel
- type ChannelTarget
- type ComponentType
- type Decoder
- type Document
- type Encoder
- type Extensions
- type Image
- type Interpolation
- type MagFilter
- type Material
- type Mesh
- type MinFilter
- type Node
- type NormalTexture
- type OcclusionTexture
- type Orthographic
- type PBRMetallicRoughness
- func (p *PBRMetallicRoughness) BaseColorFactorOrDefault() [4]float32
- func (p *PBRMetallicRoughness) MarshalJSON() ([]byte, error)
- func (p *PBRMetallicRoughness) MetallicFactorOrDefault() float32
- func (p *PBRMetallicRoughness) RoughnessFactorOrDefault() float32
- func (p *PBRMetallicRoughness) UnmarshalJSON(data []byte) error
- type Perspective
- type Primitive
- type PrimitiveMode
- type ReadHandler
- type RelativeFileHandler
- type Sampler
- type Scene
- type Skin
- type Sparse
- type SparseIndices
- type SparseValues
- type TRSProperty
- type Target
- type Texture
- type TextureInfo
- type WrappingMode
- type WriteHandler
Examples ¶
Constants ¶
const ( // TargetNone is used when the buffer should not bound to a target, for example when referenced by an sparce indices. TargetNone = 0 // TargetArrayBuffer corresponds to an array buffer. TargetArrayBuffer Target = 34962 // TargetElementArrayBuffer corresponds to an element array buffer. TargetElementArrayBuffer = 34963 )
Variables ¶
var ( // DefaultMatrix defines an identity matrix. DefaultMatrix = [16]float32{1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1} // DefaultRotation defines a quaternion without rotation. DefaultRotation = [4]float32{0, 0, 0, 1} // DefaultScale defines a scaling that does not modify the size of the object. DefaultScale = [3]float32{1, 1, 1} // DefaultTranslation defines a translation that does not move the object. DefaultTranslation = [3]float32{0, 0, 0} )
Functions ¶
func DenormalizeByte ¶ added in v0.17.0
NormalizeByte denormalize a int8 into a float32
func DenormalizeRGB ¶ added in v0.17.0
DenormalizeRGB transform a RGB uint8 color (from 0 to 255) to its float represtation (from 0 to 1).
func DenormalizeRGB64 ¶ added in v0.17.0
DenormalizeRGB64 transform a RGB uint16 color (from 0 to 65535) to its float represtation (from 0 to 1).
func DenormalizeRGBA ¶ added in v0.17.0
DenormalizeRGBA transform a RGBA uint8 color (from 0 to 255) to its float represtation (from 0 to 1).
func DenormalizeRGBA64 ¶ added in v0.17.0
DenormalizeRGBA64 transform a RGBA uint16 color (from 0 to 65535) to its float represtation (from 0 to 1).
func DenormalizeShort ¶ added in v0.17.0
DenormalizeShort denormalize a int16 into a float32
func DenormalizeUbyte ¶ added in v0.17.0
DenormalizeUbyte denormalize a uint8 into a float32
func DenormalizeUshort ¶ added in v0.17.0
DenormalizeuShort denormalize a uint16 into a float32
func NormalizeByte ¶ added in v0.17.0
NormalizeByte normalize a float32 into a int8
func NormalizeRGB ¶ added in v0.17.0
NormalizeRGB transform a RGB float32 color (from 0 to 1) to its uint8 represtation (from 0 to 255).
func NormalizeRGB64 ¶ added in v0.17.0
NormalizeRGB64 transform a RGB float32 color (from 0 to 1) to its uint16 represtation (from 0 to 65535).
func NormalizeRGBA ¶ added in v0.17.0
NormalizeRGB transform a RGBA float32 color (from 0 to 1) to its uint8 represtation (from 0 to 255).
func NormalizeRGBA64 ¶ added in v0.17.0
NormalizeRGBA64 transform a RGBA float32 color (from 0 to 1) to its uint16 represtation (from 0 to 65535).
func NormalizeShort ¶ added in v0.17.0
NormalizeShort normalize a float32 into a int16
func NormalizeUbyte ¶ added in v0.17.0
NormalizeUbyte normalize a float32 into a uint8
func NormalizeUshort ¶ added in v0.17.0
NormalizeUshort normalize a float32 into a uint16
func RegisterExtension ¶ added in v0.8.0
RegisterExtension registers a function that returns a new extension of the given byte array. This is intended to be called from the init function in packages that implement extensions.
func Save ¶
Save will save a document as a glTF with the specified by name.
Example ¶
package main import ( "github.com/qmuntal/gltf" ) func main() { doc := &gltf.Document{ Accessors: []*gltf.Accessor{ {BufferView: gltf.Index(0), ComponentType: gltf.ComponentUshort, Count: 36, Type: gltf.AccessorScalar}, {BufferView: gltf.Index(1), ComponentType: gltf.ComponentFloat, Count: 24, Max: []float32{0.5, 0.5, 0.5}, Min: []float32{-0.5, -0.5, -0.5}, Type: gltf.AccessorVec3}, {BufferView: gltf.Index(2), ComponentType: gltf.ComponentFloat, Count: 24, Type: gltf.AccessorVec3}, {BufferView: gltf.Index(3), ComponentType: gltf.ComponentFloat, Count: 24, Type: gltf.AccessorVec4}, {BufferView: gltf.Index(4), ComponentType: gltf.ComponentFloat, Count: 24, Type: gltf.AccessorVec2}, }, Asset: gltf.Asset{Version: "2.0", Generator: "FBX2glTF"}, BufferViews: []*gltf.BufferView{ {Buffer: 0, ByteLength: 72, ByteOffset: 0, Target: gltf.TargetElementArrayBuffer}, {Buffer: 0, ByteLength: 288, ByteOffset: 72, Target: gltf.TargetArrayBuffer}, {Buffer: 0, ByteLength: 288, ByteOffset: 360, Target: gltf.TargetArrayBuffer}, {Buffer: 0, ByteLength: 384, ByteOffset: 648, Target: gltf.TargetArrayBuffer}, {Buffer: 0, ByteLength: 192, ByteOffset: 1032, Target: gltf.TargetArrayBuffer}, }, Buffers: []*gltf.Buffer{{ByteLength: 1224, Data: []byte{97, 110, 121, 32, 99, 97, 114, 110, 97, 108, 32, 112, 108, 101, 97, 115}}}, Materials: []*gltf.Material{{ Name: "Default", AlphaMode: gltf.AlphaOpaque, AlphaCutoff: gltf.Float(0.5), PBRMetallicRoughness: &gltf.PBRMetallicRoughness{BaseColorFactor: &[4]float32{0.8, 0.8, 0.8, 1}, MetallicFactor: gltf.Float(0.1), RoughnessFactor: gltf.Float(0.99)}, }}, Meshes: []*gltf.Mesh{{Name: "Cube", Primitives: []*gltf.Primitive{{Indices: gltf.Index(0), Material: gltf.Index(0), Mode: gltf.PrimitiveTriangles, Attributes: map[string]uint32{"POSITION": 1, "COLOR_0": 3, "NORMAL": 2, "TEXCOORD_0": 4}}}}}, Nodes: []*gltf.Node{ {Name: "RootNode", Children: []uint32{1, 2, 3}}, {Name: "Mesh"}, {Name: "Cube", Mesh: gltf.Index(0)}, {Name: "Texture Group"}, }, Samplers: []*gltf.Sampler{{WrapS: gltf.WrapRepeat, WrapT: gltf.WrapRepeat}}, Scene: gltf.Index(0), Scenes: []*gltf.Scene{{Name: "Root Scene", Nodes: []uint32{0}}}, } if err := gltf.SaveBinary(doc, "./example.glb"); err != nil { panic(err) } }
Output:
func SaveBinary ¶ added in v0.9.0
SaveBinary will save a document as a GLB file with the specified by name.
Types ¶
type Accessor ¶
type Accessor struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Name string `json:"name,omitempty"` BufferView *uint32 `json:"bufferView,omitempty"` ByteOffset uint32 `json:"byteOffset,omitempty"` ComponentType ComponentType `json:"componentType" validate:"lte=5"` Normalized bool `json:"normalized,omitempty"` // Specifies whether integer data values should be normalized. Count uint32 `json:"count" validate:"required"` // The number of attributes referenced by this accessor. Type AccessorType `json:"type" validate:"lte=6"` Max []float32 `json:"max,omitempty" validate:"omitempty,lte=16"` // Maximum value of each component in this attribute. Min []float32 `json:"min,omitempty" validate:"omitempty,lte=16"` // Minimum value of each component in this attribute. Sparse *Sparse `json:"sparse,omitempty"` // Sparse storage of attributes that deviate from their initialization value. }
An Accessor is a typed view into a bufferView. An accessor provides a typed view into a bufferView or a subset of a bufferView similar to how WebGL's vertexAttribPointer() defines an attribute in a buffer.
type AccessorType ¶
type AccessorType uint8
AccessorType specifies if the attribute is a scalar, vector, or matrix.
const ( // AccessorScalar corresponds to a single dimension value. AccessorScalar AccessorType = iota // AccessorVec2 corresponds to a two dimensions array. AccessorVec2 // AccessorVec3 corresponds to a three dimensions array. AccessorVec3 // AccessorVec4 corresponds to a four dimensions array. AccessorVec4 // AccessorMat2 corresponds to a 2x2 matrix. AccessorMat2 // AccessorMat3 corresponds to a 3x3 matrix. AccessorMat3 // AccessorMat4 corresponds to a 4x4 matrix. AccessorMat4 )
func (AccessorType) Components ¶ added in v0.16.0
func (a AccessorType) Components() uint32
Components returns the number of components of an accessor type.
func (*AccessorType) MarshalJSON ¶ added in v0.8.0
func (a *AccessorType) MarshalJSON() ([]byte, error)
MarshalJSON marshal the accessor type with the correct default values.
func (*AccessorType) UnmarshalJSON ¶ added in v0.8.0
func (a *AccessorType) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshal the accessor type with the correct default values.
type AlphaMode ¶
type AlphaMode uint8
The AlphaMode enumeration specifying the interpretation of the alpha value of the main factor and texture.
func (*AlphaMode) MarshalJSON ¶ added in v0.8.0
MarshalJSON marshal the alpha mode with the correct default values.
func (*AlphaMode) UnmarshalJSON ¶ added in v0.8.0
UnmarshalJSON unmarshal the alpha mode with the correct default values.
type Animation ¶
type Animation struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Name string `json:"name,omitempty"` Channels []*Channel `json:"channels" validate:"required,gt=0,dive"` Samplers []*AnimationSampler `json:"samplers" validate:"required,gt=0,dive"` }
An Animation keyframe.
type AnimationSampler ¶
type AnimationSampler struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Input *uint32 `json:"input,omitempty"` // The index of an accessor containing keyframe input values. Interpolation Interpolation `json:"interpolation,omitempty" validate:"lte=2"` Output *uint32 `json:"output,omitempty"` // The index of an accessor containing keyframe output values. }
AnimationSampler combines input and output accessors with an interpolation algorithm to define a keyframe graph (but not its target).
type Asset ¶
type Asset struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Copyright string `json:"copyright,omitempty"` // A copyright message suitable for display to credit the content creator. Generator string `json:"generator,omitempty"` // Tool that generated this glTF model. Useful for debugging. Version string `json:"version" validate:"required"` // The glTF version that this asset targets. MinVersion string `json:"minVersion,omitempty"` // The minimum glTF version that this asset targets. }
An Asset is metadata about the glTF asset.
type Attribute ¶
Attribute is a map that each key corresponds to mesh attribute semantic and each value is the index of the accessor containing attribute's data.
type Buffer ¶
type Buffer struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Name string `json:"name,omitempty"` URI string `json:"uri,omitempty" validate:"omitempty"` ByteLength uint32 `json:"byteLength" validate:"required"` Data []byte `json:"-"` }
A Buffer points to binary geometry, animation, or skins. If Data length is 0 and the Buffer is an external resource the Data won't be flushed, which can be useful when there is no need to load data in memory.
func (*Buffer) EmbeddedResource ¶
func (b *Buffer) EmbeddedResource()
EmbeddedResource defines the buffer as an embedded resource and encodes the URI so it points to the the resource.
func (*Buffer) IsEmbeddedResource ¶
IsEmbeddedResource returns true if the buffer points to an embedded resource.
type BufferView ¶
type BufferView struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Buffer uint32 `json:"buffer"` ByteOffset uint32 `json:"byteOffset,omitempty"` ByteLength uint32 `json:"byteLength" validate:"required"` ByteStride uint32 `json:"byteStride,omitempty" validate:"omitempty,gte=4,lte=252"` Target Target `json:"target,omitempty" validate:"omitempty,oneof=34962 34963"` }
BufferView is a view into a buffer generally representing a subset of the buffer.
type Camera ¶
type Camera struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Name string `json:"name,omitempty"` Orthographic *Orthographic `json:"orthographic,omitempty"` Perspective *Perspective `json:"perspective,omitempty"` }
A Camera projection. A node can reference a camera to apply a transform to place the camera in the scene.
func (*Camera) MarshalJSON ¶ added in v0.8.0
MarshalJSON marshal the camera with the correct default values.
type Channel ¶
type Channel struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Sampler *uint32 `json:"sampler,omitempty"` Target ChannelTarget `json:"target"` }
The Channel targets an animation's sampler at a node's property.
type ChannelTarget ¶
type ChannelTarget struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Node *uint32 `json:"node,omitempty"` Path TRSProperty `json:"path" validate:"lte=4"` }
ChannelTarget describes the index of the node and TRS property that an animation channel targets. The Path represents the name of the node's TRS property to modify, or the "weights" of the Morph Targets it instantiates. For the "translation" property, the values that are provided by the sampler are the translation along the x, y, and z axes. For the "rotation" property, the values are a quaternion in the order (x, y, z, w), where w is the scalar. For the "scale" property, the values are the scaling factors along the x, y, and z axes.
type ComponentType ¶
type ComponentType uint16
The ComponentType is the datatype of components in the attribute. All valid values correspond to WebGL enums. 5125 (UNSIGNED_INT) is only allowed when the accessor contains indices.
const ( // ComponentFloat corresponds to a Float32Array. ComponentFloat ComponentType = iota // ComponentByte corresponds to a Int8Array. ComponentByte // ComponentUbyte corresponds to a Uint8Array. ComponentUbyte // ComponentShort corresponds to a Int16Array. ComponentShort // ComponentUshort corresponds to a Uint16Array. ComponentUshort // ComponentUint corresponds to a Uint32Array. ComponentUint )
func (ComponentType) ByteSize ¶ added in v0.16.0
func (c ComponentType) ByteSize() uint32
ByteSize returns the size of a component in bytes.
func (*ComponentType) MarshalJSON ¶ added in v0.8.0
func (c *ComponentType) MarshalJSON() ([]byte, error)
MarshalJSON marshal the component type with the correct default values.
func (*ComponentType) UnmarshalJSON ¶ added in v0.8.0
func (c *ComponentType) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshal the component type with the correct default values.
type Decoder ¶
type Decoder struct { ReadHandler ReadHandler MaxExternalBufferCount int MaxMemoryAllocation uint64 // contains filtered or unexported fields }
A Decoder reads and decodes glTF and GLB values from an input stream. ReadHandler is called to read external resources.
func NewDecoder ¶
NewDecoder returns a new decoder that reads from r with relative external buffers support.
func (*Decoder) Decode ¶
Decode reads the next JSON-encoded value from its input and stores it in the value pointed to by doc.
func (*Decoder) WithReadHandler ¶ added in v0.9.0
func (d *Decoder) WithReadHandler(h ReadHandler) *Decoder
WithReadHandler sets the ReadHandler.
type Document ¶
type Document struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` ExtensionsUsed []string `json:"extensionsUsed,omitempty"` ExtensionsRequired []string `json:"extensionsRequired,omitempty"` Accessors []*Accessor `json:"accessors,omitempty" validate:"dive"` Animations []*Animation `json:"animations,omitempty" validate:"dive"` Asset Asset `json:"asset"` Buffers []*Buffer `json:"buffers,omitempty" validate:"dive"` BufferViews []*BufferView `json:"bufferViews,omitempty" validate:"dive"` Cameras []*Camera `json:"cameras,omitempty" validate:"dive"` Images []*Image `json:"images,omitempty" validate:"dive"` Materials []*Material `json:"materials,omitempty" validate:"dive"` Meshes []*Mesh `json:"meshes,omitempty" validate:"dive"` Nodes []*Node `json:"nodes,omitempty" validate:"dive"` Samplers []*Sampler `json:"samplers,omitempty" validate:"dive"` Scene *uint32 `json:"scene,omitempty"` Scenes []*Scene `json:"scenes,omitempty" validate:"dive"` Skins []*Skin `json:"skins,omitempty" validate:"dive"` Textures []*Texture `json:"textures,omitempty" validate:"dive"` }
Document defines the root object for a glTF asset.
func NewDocument ¶ added in v0.16.0
func NewDocument() *Document
NewDocument returns a new Document with sane defaults.
type Encoder ¶
type Encoder struct { AsBinary bool WriteHandler WriteHandler // contains filtered or unexported fields }
An Encoder writes a GLTF to an output stream with relative external buffers support.
func NewEncoder ¶
NewEncoder returns a new encoder that writes to w as a normal glTF file.
func (*Encoder) WithWriteHandler ¶ added in v0.9.0
func (e *Encoder) WithWriteHandler(h WriteHandler) *Encoder
WithWriteHandler sets the WriteHandler.
type Extensions ¶
type Extensions map[string]interface{}
Extensions is map where the keys are the extension identifiers and the values are the extensions payloads. If a key matches with one of the supported extensions the value will be marshalled as a pointer to the extension struct. If a key does not match with any of the supported extensions the value will be a json.RawMessage so its decoding can be delayed.
func (*Extensions) UnmarshalJSON ¶
func (ext *Extensions) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshal the extensions with the supported extensions initialized.
type Image ¶
type Image struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Name string `json:"name,omitempty"` URI string `json:"uri,omitempty" validate:"omitempty"` MimeType string `json:"mimeType,omitempty" validate:"omitempty,oneof=image/jpeg image/png"` // Manadatory if BufferView is defined. BufferView *uint32 `json:"bufferView,omitempty"` // Use this instead of the image's uri property. }
Image data used to create a texture. Image can be referenced by URI or bufferView index. mimeType is required in the latter case.
func (*Image) IsEmbeddedResource ¶
IsEmbeddedResource returns true if the buffer points to an embedded resource.
func (*Image) MarshalData ¶
MarshalData decode the image from the URI. If the image is not en embedded resource the returned array will be empty.
type Interpolation ¶
type Interpolation uint8
Interpolation algorithm.
const ( // InterpolationLinear corresponds to a linear interpolation. InterpolationLinear Interpolation = iota // InterpolationStep corresponds to a step interpolation. InterpolationStep // InterpolationCubicSpline corresponds to a cubic spline interpolation. InterpolationCubicSpline )
func (*Interpolation) MarshalJSON ¶ added in v0.8.0
func (i *Interpolation) MarshalJSON() ([]byte, error)
MarshalJSON marshal the interpolation with the correct default values.
func (*Interpolation) UnmarshalJSON ¶ added in v0.8.0
func (i *Interpolation) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshal the interpolation with the correct default values.
type MagFilter ¶
type MagFilter uint16
MagFilter is the magnification filter.
func (*MagFilter) MarshalJSON ¶ added in v0.8.0
MarshalJSON marshal the alpha mode with the correct default values.
func (*MagFilter) UnmarshalJSON ¶ added in v0.8.0
UnmarshalJSON unmarshal the mag filter with the correct default values.
type Material ¶
type Material struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Name string `json:"name,omitempty"` PBRMetallicRoughness *PBRMetallicRoughness `json:"pbrMetallicRoughness,omitempty"` NormalTexture *NormalTexture `json:"normalTexture,omitempty"` OcclusionTexture *OcclusionTexture `json:"occlusionTexture,omitempty"` EmissiveTexture *TextureInfo `json:"emissiveTexture,omitempty"` EmissiveFactor [3]float32 `json:"emissiveFactor,omitempty" validate:"dive,gte=0,lte=1"` AlphaMode AlphaMode `json:"alphaMode,omitempty" validate:"lte=2"` AlphaCutoff *float32 `json:"alphaCutoff,omitempty" validate:"omitempty,gte=0"` DoubleSided bool `json:"doubleSided,omitempty"` }
The Material appearance of a primitive.
func (*Material) AlphaCutoffOrDefault ¶ added in v0.8.0
AlphaCutoffOrDefault returns the scale if it is not nil, else return the default one.
func (*Material) MarshalJSON ¶
MarshalJSON marshal the material with the correct default values.
func (*Material) UnmarshalJSON ¶
UnmarshalJSON unmarshal the material with the correct default values.
type Mesh ¶
type Mesh struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Name string `json:"name,omitempty"` Primitives []*Primitive `json:"primitives" validate:"required,gt=0,dive"` Weights []float32 `json:"weights,omitempty"` }
A Mesh is a set of primitives to be rendered. A node can contain one mesh. A node's transform places the mesh in the scene.
type MinFilter ¶
type MinFilter uint16
MinFilter is the minification filter.
const ( // MinLinear corresponds to a linear minification filter. MinLinear MinFilter = iota // MinNearestMipMapLinear corresponds to a nearest mipmap linear minification filter. MinNearestMipMapLinear // MinNearest corresponds to a nearest minification filter. MinNearest // MinNearestMipMapNearest corresponds to a nearest mipmap nearest minification filter. MinNearestMipMapNearest // MinLinearMipMapNearest corresponds to a linear mipmap nearest minification filter. MinLinearMipMapNearest // MinLinearMipMapLinear corresponds to a linear mipmap linear minification filter. MinLinearMipMapLinear )
func (*MinFilter) MarshalJSON ¶ added in v0.8.0
MarshalJSON marshal the min filter with the correct default values.
func (*MinFilter) UnmarshalJSON ¶ added in v0.8.0
UnmarshalJSON unmarshal the min filter with the correct default values.
type Node ¶
type Node struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Name string `json:"name,omitempty"` Camera *uint32 `json:"camera,omitempty"` Children []uint32 `json:"children,omitempty" validate:"omitempty,unique"` Skin *uint32 `json:"skin,omitempty"` Matrix [16]float32 `json:"matrix"` // A 4x4 transformation matrix stored in column-major order. Mesh *uint32 `json:"mesh,omitempty"` Rotation [4]float32 `json:"rotation" validate:"omitempty,dive,gte=-1,lte=1"` // The node's unit quaternion rotation in the order (x, y, z, w), where w is the scalar. Scale [3]float32 `json:"scale"` Translation [3]float32 `json:"translation"` Weights []float32 `json:"weights,omitempty"` // The weights of the instantiated Morph Target. }
A Node in the node hierarchy. It can have either a matrix or any combination of translation/rotation/scale (TRS) properties.
func (*Node) MarshalJSON ¶
MarshalJSON marshal the node with the correct default values.
func (*Node) MatrixOrDefault ¶ added in v0.8.0
MatrixOrDefault returns the node matrix if it represents a valid affine matrix, else return the default one.
func (*Node) RotationOrDefault ¶ added in v0.8.0
RotationOrDefault returns the node rotation if it represents a valid quaternion, else return the default one.
func (*Node) ScaleOrDefault ¶ added in v0.8.0
ScaleOrDefault returns the node scale if it represents a valid scale factor, else return the default one.
func (*Node) TranslationOrDefault ¶ added in v0.8.0
TranslationOrDefault returns the node translation.
func (*Node) UnmarshalJSON ¶
UnmarshalJSON unmarshal the node with the correct default values.
type NormalTexture ¶
type NormalTexture struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Index *uint32 `json:"index,omitempty"` TexCoord uint32 `json:"texCoord,omitempty"` // The index of texture's TEXCOORD attribute used for texture coordinate mapping. Scale *float32 `json:"scale,omitempty"` }
A NormalTexture references to a normal texture.
func (*NormalTexture) MarshalJSON ¶
func (n *NormalTexture) MarshalJSON() ([]byte, error)
MarshalJSON marshal the texture info with the correct default values.
func (*NormalTexture) ScaleOrDefault ¶ added in v0.8.0
func (n *NormalTexture) ScaleOrDefault() float32
ScaleOrDefault returns the scale if it is not nil, else return the default one.
func (*NormalTexture) UnmarshalJSON ¶
func (n *NormalTexture) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshal the texture info with the correct default values.
type OcclusionTexture ¶
type OcclusionTexture struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Index *uint32 `json:"index,omitempty"` TexCoord uint32 `json:"texCoord,omitempty"` // The index of texture's TEXCOORD attribute used for texture coordinate mapping. Strength *float32 `json:"strength,omitempty" validate:"omitempty,gte=0,lte=1"` }
An OcclusionTexture references to an occlusion texture
func (*OcclusionTexture) MarshalJSON ¶
func (o *OcclusionTexture) MarshalJSON() ([]byte, error)
MarshalJSON marshal the texture info with the correct default values.
func (*OcclusionTexture) StrengthOrDefault ¶ added in v0.8.0
func (o *OcclusionTexture) StrengthOrDefault() float32
StrengthOrDefault returns the strength if it is not nil, else return the default one.
func (*OcclusionTexture) UnmarshalJSON ¶
func (o *OcclusionTexture) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshal the texture info with the correct default values.
type Orthographic ¶
type Orthographic struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Xmag float32 `json:"xmag"` // The horizontal magnification of the view. Ymag float32 `json:"ymag"` // The vertical magnification of the view. Zfar float32 `json:"zfar" validate:"gt=0,gtfield=Znear"` // The distance to the far clipping plane. Znear float32 `json:"znear" validate:"gte=0"` // The distance to the near clipping plane. }
Orthographic camera containing properties to create an orthographic projection matrix.
type PBRMetallicRoughness ¶
type PBRMetallicRoughness struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` BaseColorFactor *[4]float32 `json:"baseColorFactor,omitempty" validate:"omitempty,dive,gte=0,lte=1"` BaseColorTexture *TextureInfo `json:"baseColorTexture,omitempty"` MetallicFactor *float32 `json:"metallicFactor,omitempty" validate:"omitempty,gte=0,lte=1"` RoughnessFactor *float32 `json:"roughnessFactor,omitempty" validate:"omitempty,gte=0,lte=1"` MetallicRoughnessTexture *TextureInfo `json:"metallicRoughnessTexture,omitempty"` }
PBRMetallicRoughness defines a set of parameter values that are used to define the metallic-roughness material model from Physically-Based Rendering (PBR) methodology.
func (*PBRMetallicRoughness) BaseColorFactorOrDefault ¶ added in v0.8.0
func (p *PBRMetallicRoughness) BaseColorFactorOrDefault() [4]float32
BaseColorFactorOrDefault returns the base color factor if it is not nil, else return the default one.
func (*PBRMetallicRoughness) MarshalJSON ¶
func (p *PBRMetallicRoughness) MarshalJSON() ([]byte, error)
MarshalJSON marshal the pbr with the correct default values.
func (*PBRMetallicRoughness) MetallicFactorOrDefault ¶ added in v0.8.0
func (p *PBRMetallicRoughness) MetallicFactorOrDefault() float32
MetallicFactorOrDefault returns the metallic factor if it is not nil, else return the default one.
func (*PBRMetallicRoughness) RoughnessFactorOrDefault ¶ added in v0.8.0
func (p *PBRMetallicRoughness) RoughnessFactorOrDefault() float32
RoughnessFactorOrDefault returns the roughness factor if it is not nil, else return the default one.
func (*PBRMetallicRoughness) UnmarshalJSON ¶
func (p *PBRMetallicRoughness) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshal the pbr with the correct default values.
type Perspective ¶
type Perspective struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` AspectRatio *float32 `json:"aspectRatio,omitempty"` Yfov float32 `json:"yfov"` // The vertical field of view in radians. Zfar *float32 `json:"zfar,omitempty"` // The distance to the far clipping plane. Znear float32 `json:"znear"` // The distance to the near clipping plane. }
Perspective camera containing properties to create a perspective projection matrix.
type Primitive ¶
type Primitive struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Attributes Attribute `json:"attributes"` Indices *uint32 `json:"indices,omitempty"` // The index of the accessor that contains the indices. Material *uint32 `json:"material,omitempty"` Mode PrimitiveMode `json:"mode,omitempty" validate:"lte=6"` Targets []Attribute `json:"targets,omitempty" validate:"omitempty,dive,dive,keys,oneof=POSITION NORMAL TANGENT,endkeys"` // Only POSITION, NORMAL, and TANGENT supported. }
Primitive defines the geometry to be rendered with the given material.
type PrimitiveMode ¶
type PrimitiveMode uint8
PrimitiveMode defines the type of primitives to render. All valid values correspond to WebGL enums.
const ( // PrimitiveTriangles corresponds to a Triangle primitive. PrimitiveTriangles PrimitiveMode = iota // PrimitivePoints corresponds to a Point primitive. PrimitivePoints // PrimitiveLines corresponds to a Line primitive. PrimitiveLines // PrimitiveLineLoop corresponds to a Line Loop primitive. PrimitiveLineLoop // PrimitiveLineStrip corresponds to a Line Strip primitive. PrimitiveLineStrip // PrimitiveTriangleStrip corresponds to a Triangle Strip primitive. PrimitiveTriangleStrip // PrimitiveTriangleFan corresponds to a Triangle Fan primitive. PrimitiveTriangleFan )
func (*PrimitiveMode) MarshalJSON ¶ added in v0.8.0
func (p *PrimitiveMode) MarshalJSON() ([]byte, error)
MarshalJSON marshal the primitive mode with the correct default values.
func (*PrimitiveMode) UnmarshalJSON ¶ added in v0.8.0
func (p *PrimitiveMode) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshal the primitive mode with the correct default values.
type ReadHandler ¶ added in v0.9.0
ReadHandler is the interface that wraps the ReadFullResource method.
ReadFullResource should behaves as io.ReadFull in terms of reading the external resource. The data already has the correct size so it can be used directly to store the read output.
type RelativeFileHandler ¶ added in v0.9.0
type RelativeFileHandler struct {
Dir string
}
RelativeFileHandler implements a secure ReadHandler supporting relative paths. If Dir is empty the os.Getws will be used. It comes with directory traversal protection.
func (*RelativeFileHandler) ReadFullResource ¶ added in v0.9.0
func (h *RelativeFileHandler) ReadFullResource(uri string, data []byte) error
ReadFullResource reads all the resource data using io.ReadFull.
func (*RelativeFileHandler) WriteResource ¶ added in v0.9.0
func (h *RelativeFileHandler) WriteResource(uri string, data []byte) error
WriteResource writes the resource using io.WriteFile.
type Sampler ¶
type Sampler struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Name string `json:"name,omitempty"` MagFilter MagFilter `json:"magFilter,omitempty" validate:"lte=1"` MinFilter MinFilter `json:"minFilter,omitempty" validate:"lte=5"` WrapS WrappingMode `json:"wrapS,omitempty" validate:"lte=2"` WrapT WrappingMode `json:"wrapT,omitempty" validate:"lte=2"` }
Sampler of a texture for filtering and wrapping modes.
type Scene ¶
type Scene struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Name string `json:"name,omitempty"` Nodes []uint32 `json:"nodes,omitempty" validate:"omitempty,unique"` }
The Scene contains a list of root nodes.
type Skin ¶
type Skin struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Name string `json:"name,omitempty"` InverseBindMatrices *uint32 `json:"inverseBindMatrices,omitempty"` // The index of the accessor containing the floating-point 4x4 inverse-bind matrices. Skeleton *uint32 `json:"skeleton,omitempty"` // The index of the node used as a skeleton root. When undefined, joints transforms resolve to scene root. Joints []uint32 `json:"joints" validate:"omitempty,unique"` // Indices of skeleton nodes, used as joints in this skin. }
Skin defines joints and matrices.
type Sparse ¶
type Sparse struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Count uint32 `json:"count" validate:"gte=1"` // Number of entries stored in the sparse array. Indices SparseIndices `json:"indices"` // Index array of size count that points to those accessor attributes that deviate from their initialization value. Values SparseValues `json:"values"` // Array of size count times number of components, storing the displaced accessor attributes pointed by indices. }
Sparse storage of attributes that deviate from their initialization value.
type SparseIndices ¶
type SparseIndices struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` BufferView uint32 `json:"bufferView"` ByteOffset uint32 `json:"byteOffset,omitempty"` ComponentType ComponentType `json:"componentType" validate:"oneof=2 4 5"` }
SparseIndices defines the indices of those attributes that deviate from their initialization value.
type SparseValues ¶
type SparseValues struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` BufferView uint32 `json:"bufferView"` ByteOffset uint32 `json:"byteOffset,omitempty"` }
SparseValues stores the displaced accessor attributes pointed by accessor.sparse.indices.
type TRSProperty ¶
type TRSProperty uint8
TRSProperty defines a local space transformation. TRSproperties are converted to matrices and postmultiplied in the T * R * S order to compose the transformation matrix.
const ( // TRSTranslation corresponds to a translation transform. TRSTranslation TRSProperty = iota // TRSRotation corresponds to a rotation transform. TRSRotation // TRSScale corresponds to a scale transform. TRSScale // TRSWeights corresponds to a weights transform. TRSWeights )
func (*TRSProperty) MarshalJSON ¶ added in v0.8.0
func (t *TRSProperty) MarshalJSON() ([]byte, error)
MarshalJSON marshal the TRSProperty with the correct default values.
func (*TRSProperty) UnmarshalJSON ¶ added in v0.8.0
func (t *TRSProperty) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshal the TRSProperty with the correct default values.
type Texture ¶
type Texture struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Name string `json:"name,omitempty"` Sampler *uint32 `json:"sampler,omitempty"` Source *uint32 `json:"source,omitempty"` }
A Texture and its sampler.
type TextureInfo ¶
type TextureInfo struct { Extensions Extensions `json:"extensions,omitempty"` Extras interface{} `json:"extras,omitempty"` Index uint32 `json:"index"` TexCoord uint32 `json:"texCoord,omitempty"` // The index of texture's TEXCOORD attribute used for texture coordinate mapping. }
TextureInfo references to a texture.
type WrappingMode ¶
type WrappingMode uint16
WrappingMode is the wrapping mode of a texture.
const ( // WrapRepeat corresponds to a repeat wrapping. WrapRepeat WrappingMode = iota // WrapClampToEdge corresponds to a clamp to edge wrapping. WrapClampToEdge // WrapMirroredRepeat corresponds to a mirrored repeat wrapping. WrapMirroredRepeat )
func (*WrappingMode) MarshalJSON ¶ added in v0.8.0
func (w *WrappingMode) MarshalJSON() ([]byte, error)
MarshalJSON marshal the wrapping mode with the correct default values.
func (*WrappingMode) UnmarshalJSON ¶ added in v0.8.0
func (w *WrappingMode) UnmarshalJSON(data []byte) error
UnmarshalJSON unmarshal the wrapping mode with the correct default values.
type WriteHandler ¶ added in v0.9.0
WriteHandler is the interface that wraps the Write method.
WriteResource should behaves as io.Write in terms of reading the writing resource.
Directories ¶
Path | Synopsis |
---|---|
Package binary implements simple translation between numbers and byte sequences.
|
Package binary implements simple translation between numbers and byte sequences. |
ext
|
|
lightspuntual
Package lightspuntual defines three "punctual" light types: directional, point and spot.
|
Package lightspuntual defines three "punctual" light types: directional, point and spot. |
Package modeler implements helper methods to write common glTF entities (indices, positions, colors, ...) into buffers.
|
Package modeler implements helper methods to write common glTF entities (indices, positions, colors, ...) into buffers. |