savoiardi/texture

Texture loading and texture configuration.

The public API covers both regular textures and cube textures together with the most common color-space, mapping, wrapping, and filtering controls.

Types

ColorSpace

</>

Output color spaces supported by the texture API.

pub type ColorSpace {
  SRGB
  LinearSRGB
}

Constructors

```
SRGB
```
```
LinearSRGB
```

CubeTexture

</>

A cube texture.

pub type CubeTexture

MagnificationFilter

</>

Magnification filters.

pub type MagnificationFilter {
  Nearest
  Linear
}

Constructors

```
Nearest
```
```
Linear
```

Mapping

</>

Texture coordinate mappings supported by the texture API.

pub type Mapping {
  UV
  CubeReflection
  CubeRefraction
  EquirectangularReflection
  EquirectangularRefraction
}

Constructors

```
UV
```
```
CubeReflection
```
```
CubeRefraction
```
```
EquirectangularReflection
```
```
EquirectangularRefraction
```

MinificationFilter

</>

Minification filters.

pub type MinificationFilter {
  NearestMinification
  NearestMipmapNearest
  NearestMipmapLinear
  LinearMinification
  LinearMipmapNearest
  LinearMipmapLinear
}

Constructors

```
NearestMinification
```
```
NearestMipmapNearest
```
```
NearestMipmapLinear
```
```
LinearMinification
```
```
LinearMipmapNearest
```
```
LinearMipmapLinear
```

Texture

</>

A 2D texture.

pub type Texture

Wrapping

</>

Texture wrapping modes.

pub type Wrapping {
  Repeat
  ClampToEdge
  MirroredRepeat
}

Constructors

```
Repeat
```
```
ClampToEdge
```
```
MirroredRepeat
```

Values

color_space_to_string

</>

pub fn color_space_to_string(space: ColorSpace) -> String

Converts a color space to the underlying Three.js constant.

dispose

</>

pub fn dispose(texture: Texture) -> Nil

Disposes a texture.

load

</>

pub fn load(
  loader: loader.TextureLoader,
  url: String,
  on_result: fn(Result(Texture, loader.LoadError)) -> Nil,
) -> Nil

Loads a texture and reports the result through a callback.

load_async

</>

pub fn load_async(
  loader: loader.TextureLoader,
  url: String,
) -> promise.Promise(Result(Texture, loader.LoadError))

Loads a texture asynchronously.

load_cube

</>

pub fn load_cube(
  loader: loader.CubeTextureLoader,
  urls: List(String),
  on_result: fn(Result(CubeTexture, loader.LoadError)) -> Nil,
) -> Nil

Loads a cube texture from six URLs and reports the result through a callback.

load_cube_async

</>

pub fn load_cube_async(
  loader: loader.CubeTextureLoader,
  urls: List(String),
) -> promise.Promise(Result(CubeTexture, loader.LoadError))

Loads a cube texture from six URLs asynchronously.

load_equirectangular

</>

pub fn load_equirectangular(
  loader: loader.TextureLoader,
  url: String,
  on_result: fn(Result(Texture, loader.LoadError)) -> Nil,
) -> Nil

Loads an equirectangular texture and reports the result through a callback.

load_equirectangular_async

</>

pub fn load_equirectangular_async(
  loader: loader.TextureLoader,
  url: String,
) -> promise.Promise(Result(Texture, loader.LoadError))

Loads an equirectangular texture asynchronously.

set_anisotropy

</>

pub fn set_anisotropy(
  texture: Texture,
  anisotropy: Int,
) -> Texture

Sets the anisotropy level of a texture.

set_center

</>

pub fn set_center(
  texture: Texture,
  center: vec2.Vec2(Float),
) -> Texture

Sets the UV center of a texture.

set_color_space

</>

pub fn set_color_space(
  texture: Texture,
  color_space: ColorSpace,
) -> Texture

Sets the color space of a texture.

set_cube_mapping

</>

pub fn set_cube_mapping(
  cube_texture: CubeTexture,
  mapping: Mapping,
) -> CubeTexture

Sets the mapping mode of a cube texture.

set_flip_y

</>

pub fn set_flip_y(texture: Texture, flip_y: Bool) -> Texture

Enables or disables vertical flipping when uploading a texture.

set_generate_mipmaps

</>

pub fn set_generate_mipmaps(
  texture: Texture,
  generate_mipmaps: Bool,
) -> Texture

Enables or disables mipmap generation.

set_mag_filter

</>

pub fn set_mag_filter(
  texture: Texture,
  filter: MagnificationFilter,
) -> Texture

Sets the magnification filter of a texture.

set_mapping

</>

pub fn set_mapping(texture: Texture, mapping: Mapping) -> Texture

Sets the mapping mode of a texture.

set_min_filter

</>

pub fn set_min_filter(
  texture: Texture,
  filter: MinificationFilter,
) -> Texture

Sets the minification filter of a texture.

set_needs_update

</>

pub fn set_needs_update(
  texture: Texture,
  needs_update: Bool,
) -> Texture

Marks a texture as needing an update.

set_offset

</>

pub fn set_offset(
  texture: Texture,
  offset: vec2.Vec2(Float),
) -> Texture

Sets the offset vector of a texture.

set_repeat

</>

pub fn set_repeat(
  texture: Texture,
  repeat: vec2.Vec2(Float),
) -> Texture

Sets the repeat vector of a texture.

set_rotation

</>

pub fn set_rotation(texture: Texture, rotation: Float) -> Texture

Sets the UV rotation of a texture.

set_wrap

</>

pub fn set_wrap(
  texture: Texture,
  wrap_s: Wrapping,
  wrap_t: Wrapping,
) -> Texture

Sets both wrapping modes of a texture.

set_wrap_s

</>

pub fn set_wrap_s(
  texture: Texture,
  wrapping: Wrapping,
) -> Texture

Sets the horizontal wrapping mode of a texture.

set_wrap_t

</>

pub fn set_wrap_t(
  texture: Texture,
  wrapping: Wrapping,
) -> Texture

Sets the vertical wrapping mode of a texture.