TextureLoader

Defined in: packages/three-flatland/src/loaders/TextureLoader.ts:39

Texture loader with hierarchical preset support.

Extends Three.js’s Loader class for compatibility with R3F’s useLoader. Automatically applies texture presets based on the hierarchy:

1. TextureLoader.options (static loader default)
2. TextureConfig.options (texture-specific default)
3. FlatlandConfig.options (library-wide default)
4. ‘pixel-art’ (system default)

Example

// Three.js usage - static API
const texture = await TextureLoader.load('/sprites/player.png')

// R3F usage - works with useLoader
import { TextureLoader } from 'three-flatland/react'
const texture = useLoader(TextureLoader, '/sprite.png')
// Presets are automatically applied!

// Override presets for specific textures
const smoothTexture = await TextureLoader.load('/ui.png', { texture: 'smooth' })

// Set loader-level default
TextureLoader.options = 'smooth'

Extends

• Loader <Texture >

Constructors

Constructor

new TextureLoader(manager?): TextureLoader

Defined in: three.js/loaders/Loader:TextureLoader 

Parameters

manager?

LoadingManager 

Returns

TextureLoader

Inherited from

Loader<Texture>.constructor

Properties

crossOrigin

crossOrigin: string

Defined in: three.js/loaders/Loader:crossOrigin 

Default

'anonymous'

Inherited from

Loader.crossOrigin

---

manager

manager: LoadingManager 

Defined in: three.js/loaders/Loader:manager 

Inherited from

Loader.manager

---

path

path: string

Defined in: three.js/loaders/Loader:path 

Default

''

Inherited from

Loader.path

---

preset

preset: TexturePreset | TextureOptions | undefined = undefined

Defined in: packages/three-flatland/src/loaders/TextureLoader.ts:61

Instance-level preset override. Set via R3F’s useLoader extension callback.

Example

// Override preset for specific textures via extension
const texture = useLoader(TextureLoader, '/ui.png', (loader) => {
  loader.preset = 'smooth'
})

---

requestHeader

requestHeader: object

Defined in: three.js/loaders/Loader:requestHeader 

Index Signature

[header: string]: string

Default

{}

Inherited from

Loader.requestHeader

---

resourcePath

resourcePath: string

Defined in: three.js/loaders/Loader:resourcePath 

Default

''

Inherited from

Loader.resourcePath

---

withCredentials

withCredentials: boolean

Defined in: three.js/loaders/Loader:withCredentials 

Default

false

Inherited from

Loader.withCredentials

---

DEFAULT_MATERIAL_NAME

static DEFAULT_MATERIAL_NAME: string

Defined in: three.js/loaders/Loader:DEFAULT_MATERIAL_NAME 

Inherited from

Loader.DEFAULT_MATERIAL_NAME

---

options

static options: TexturePreset | TextureOptions | undefined = undefined

Defined in: packages/three-flatland/src/loaders/TextureLoader.ts:47

Texture options for this loader class. When undefined, falls through to TextureConfig.options.

Methods

abort()

abort(): this

Defined in: three.js/loaders/Loader:abort 

Returns

this

Inherited from

Loader.abort

---

load()

load(url, onLoad?, onProgress?, onError?): Texture 

Defined in: packages/three-flatland/src/loaders/TextureLoader.ts:67

Load a texture (callback style for R3F useLoader compatibility). Presets are automatically applied.

Parameters

url

string

onLoad?

(texture) => void

onProgress?

(event) => void

onError?

(err) => void

Returns

Texture 

Overrides

Loader.load

---

loadAsync()

loadAsync(url, onProgress?): Promise<Texture <unknown, TextureEventMap >>

Defined in: packages/three-flatland/src/loaders/TextureLoader.ts:91

Load a texture asynchronously. Presets are automatically applied.

Parameters

url

string

onProgress?

(event) => void

Returns

Promise<Texture <unknown, TextureEventMap >>

Overrides

Loader.loadAsync

---

setCrossOrigin()

setCrossOrigin(crossOrigin): this

Defined in: three.js/loaders/Loader:setCrossOrigin 

Parameters

crossOrigin

string

Returns

this

Inherited from

Loader.setCrossOrigin

---

setPath()

setPath(path): this

Defined in: three.js/loaders/Loader:setPath 

Parameters

path

string

Returns

this

Inherited from

Loader.setPath

---

setRequestHeader()

setRequestHeader(requestHeader): this

Defined in: three.js/loaders/Loader:setRequestHeader 

Parameters

requestHeader

Returns

this

Inherited from

Loader.setRequestHeader

---

setResourcePath()

setResourcePath(resourcePath): this

Defined in: three.js/loaders/Loader:setResourcePath 

Parameters

resourcePath

string

Returns

this

Inherited from

Loader.setResourcePath

---

setWithCredentials()

setWithCredentials(value): this

Defined in: three.js/loaders/Loader:setWithCredentials 

Parameters

value

boolean

Returns

this

Inherited from

Loader.setWithCredentials

---

clearCache()

static clearCache(): void

Defined in: packages/three-flatland/src/loaders/TextureLoader.ts:155

Clear the cache.

Returns

void

---

load()

static load(url, options?): Promise<Texture <unknown, TextureEventMap >>

Defined in: packages/three-flatland/src/loaders/TextureLoader.ts:105

Load a texture from a URL (static method for Three.js usage). Results are cached by URL and resolved options.

Parameters

url

string

options?

TextureLoaderOptions

Returns

Promise<Texture <unknown, TextureEventMap >>

---

preload()

static preload(urls, options?): Promise<Texture <unknown, TextureEventMap >[]>

Defined in: packages/three-flatland/src/loaders/TextureLoader.ts:148

Preload multiple textures.

Parameters

urls

string[]

options?

TextureLoaderOptions

Returns

Promise<Texture <unknown, TextureEventMap >[]>