binary

Documentation

Overview

Package binary implements simple translation between numbers and byte sequences.

Numbers are translated by reading and writing fixed-size values. A fixed-size value is either a fixed-size arithmetic type (bool, int8, uint8, int16, float32, complex64, ...) or an array or struct containing only fixed-size values.

Even though the defined structs don't implement a common interface, they all follow the same `generic` interface, and the only difference is the type of the value:

type Component interface {
  Scalar([]byte) any
  Vec2([]byte) [2]any
  Vec3([]byte) [2]any
  Vec4([]byte) [2]any
  Mat2([]byte) [2][2]any
  Mat3([]byte) [3][3]any
  Mat4([]byte) [4][4]any
  PutScalar([]byte, any)
  PutVec2([]byte, [2]any)
  PutVec3([]byte, [3]any)
  PutVec4([]byte, [4]any)
  PutMat2([]byte, [2][2]any)
  PutMat3([]byte, [3][3]any)
  PutMat4([]byte, [4][4]any)
}

This package favors simplicity and compliance over efficiency, but it is still an order of magnitude more performant than using the built-in `binary` package, as it implements fast paths for basic glTF types and slices.

Index

• Variables
• func MakeSlice(c gltf.ComponentType, t gltf.AccessorType, count int) (any, error)
• func MakeSliceBuffer(c gltf.ComponentType, t gltf.AccessorType, count int, buffer []byte) (any, error)
• func Read(b []byte, byteStride int, data any) error
• func Type(data any) (c gltf.ComponentType, t gltf.AccessorType, count int)
• func Write(b []byte, stride int, data any) error

Examples

• Read
• Write

Variables

var Byte byteComponent

Byte is the byte implementation of Component.

var Float floatComponent

Float is the float implementation of Component.

var Short shortComponent

Short is the byte short of Component.

var Ubyte ubyteComponent

Ubyte is the usnigned byte implementation of Component.

var Uint uintComponent

Uint is the unsigned int implementation of Component.

var Ushort ushortComponent

Ushort is the usnigned short implementation of Component.

Functions

func MakeSlice

func MakeSlice(c gltf.ComponentType, t gltf.AccessorType, count int) (any, error)

MakeSlice returns the slice type associated with c and t and with the given element count. For example, if c is gltf.ComponentFloat and t is gltf.AccessorVec3 then MakeSlice(c, t, 5) is equivalent to make([][3]float32, 5).

func MakeSliceBuffer

func MakeSliceBuffer(c gltf.ComponentType, t gltf.AccessorType, count int, buffer []byte) (any, error)

MakeSliceBuffer returns the slice type associated with c and t and with the given element count. If the buffer is an slice which type matches with the expected by the acr then it will be used as backing slice.

func Read

func Read(b []byte, byteStride int, data any) error

Read reads structured binary data from b into data. byteStride can be zero for non-interleaved buffer views.

Data should be a slice of glTF predefined fixed-size types. If data length is greater than the length of b, Read returns io.ErrShortBuffer.

Example

package main

import (
	"fmt"

	"github.com/qmuntal/gltf"
	"github.com/qmuntal/gltf/binary"
)

func main() {
	// Allocate data
	indices := make([]uint8, 18)
	vertices := make([][3]float32, 5)

	// Define buffer
	b := []byte{0, 1, 2, 3, 1, 0, 0, 2, 3, 1, 4, 2, 4, 3, 2, 4, 1, 3, 0, 0, 44, 66, 0, 0, 44, 66, 0, 0, 0, 0, 0, 0, 166, 66, 0, 0, 44, 66, 0, 0, 0, 0, 0, 0, 124, 66, 0, 0, 124, 66, 0, 0, 32, 66, 0, 0, 44, 66, 0, 0, 166, 66, 0, 0, 0, 0, 0, 0, 166, 66, 0, 0, 166, 66, 0, 0, 0, 0}
	sizeIndices := len(indices) * gltf.SizeOfElement(gltf.ComponentUbyte, gltf.AccessorScalar)

	// Read
	binary.Read(b, 0, indices)
	binary.Read(b[sizeIndices:], 0, vertices)

	fmt.Println(indices)
	fmt.Println(vertices)
}

Output:

[0 1 2 3 1 0 0 2 3 1 4 2 4 3 2 4 1 3]
[[43 43 0] [83 43 0] [63 63 40] [43 83 0] [83 83 0]]

func Type

func Type(data any) (c gltf.ComponentType, t gltf.AccessorType, count int)

Type returns the associated glTF type data. It panics if data is not an slice.

func Write

func Write(b []byte, stride int, data any) error

Write writes the binary representation of data into b. If stride is diferent than zero data will be interleaved.

Data must be a slice of glTF predefined fixed-size types, else it fallbacks to `encoding/binary.Write`.

Example

package main

import (
	"fmt"

	"github.com/qmuntal/gltf"
	"github.com/qmuntal/gltf/binary"
)

func main() {
	// Define data
	indices := []uint8{0, 1, 2, 3, 1, 0, 0, 2, 3, 1, 4, 2, 4, 3, 2, 4, 1, 3}
	vertices := [][3]float32{{43, 43, 0}, {83, 43, 0}, {63, 63, 40}, {43, 83, 0}, {83, 83, 0}}

	// Allocate buffer
	sizeIndices := len(indices) * gltf.SizeOfElement(gltf.ComponentUbyte, gltf.AccessorScalar)
	sizeVertices := len(vertices) * gltf.SizeOfElement(gltf.ComponentFloat, gltf.AccessorVec3)
	b := make([]byte, sizeIndices+sizeVertices)

	// Write
	binary.Write(b, 0, indices)
	binary.Write(b[sizeIndices:], 0, vertices)

	fmt.Print(b)
}

Output:

[0 1 2 3 1 0 0 2 3 1 4 2 4 3 2 4 1 3 0 0 44 66 0 0 44 66 0 0 0 0 0 0 166 66 0 0 44 66 0 0 0 0 0 0 124 66 0 0 124 66 0 0 32 66 0 0 44 66 0 0 166 66 0 0 0 0 0 0 166 66 0 0 166 66 0 0 0 0]