TextureSampler | Babylon.js API documentation

Class TextureSampler

Class used to store a texture sampler data

Hierarchy (View Summary)

TextureSampler
- InternalTexture

Index

Constructors

constructor

new TextureSampler(): TextureSampler
Creates a Sampler instance

Returns TextureSampler
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76229

Properties

`Optional`label

label?: string

General label used for debugging or storing a name.

samplingMode

samplingMode: number

Gets the sampling mode of the texture

Accessors

anisotropicFilteringLevel

get anisotropicFilteringLevel(): Nullable<number>
With compliant hardware and browser (supporting anisotropic filtering) this defines the level of anisotropic filtering in the texture. The higher the better but the slower.

Returns Nullable<number>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76198
set anisotropicFilteringLevel(value: Nullable<number>): void
Parameters
- value: Nullable<number>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76199

comparisonFunction

get comparisonFunction(): number
Gets or sets the comparison function (Constants.LESS, Constants.EQUAL, etc). Set 0 to not use a comparison function

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76203
set comparisonFunction(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76204

useMipMaps

get useMipMaps(): boolean
Indicates to use the mip maps (if available on the texture). Thanks to this flag, you can instruct the sampler to not sample the mipmaps even if they exist (and if the sampling mode is set to a value that normally samples the mipmaps!)

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76210
set useMipMaps(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76211

wrapR

get wrapR(): Nullable<number>
Value Type Description

0 CLAMP_ADDRESSMODE

1 WRAP_ADDRESSMODE

2 MIRROR_ADDRESSMODE

Returns Nullable<number>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76191
set wrapR(value: Nullable<number>): void
Parameters
- value: Nullable<number>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76192

Value	Type	Description
0	CLAMP_ADDRESSMODE
1	WRAP_ADDRESSMODE
2	MIRROR_ADDRESSMODE

wrapU

get wrapU(): Nullable<number>
Value Type Description

0 CLAMP_ADDRESSMODE

1 WRAP_ADDRESSMODE

2 MIRROR_ADDRESSMODE

Returns Nullable<number>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76173
set wrapU(value: Nullable<number>): void
Parameters
- value: Nullable<number>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76174

Value	Type	Description
0	CLAMP_ADDRESSMODE
1	WRAP_ADDRESSMODE
2	MIRROR_ADDRESSMODE

wrapV

get wrapV(): Nullable<number>
Value Type Description

0 CLAMP_ADDRESSMODE

1 WRAP_ADDRESSMODE

2 MIRROR_ADDRESSMODE

Returns Nullable<number>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76182
set wrapV(value: Nullable<number>): void
Parameters
- value: Nullable<number>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76183

Value	Type	Description
0	CLAMP_ADDRESSMODE
1	WRAP_ADDRESSMODE
2	MIRROR_ADDRESSMODE

Methods

compareSampler

compareSampler(other: TextureSampler): boolean
Compares this sampler with another one
Parameters
- other: TextureSampler
  sampler to compare with
Returns boolean
true if the samplers have the same parametres, else false
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76246

setParameters

setParameters(
    wrapU?: number,
    wrapV?: number,
    wrapR?: number,
    anisotropicFilteringLevel?: number,
    samplingMode?: number,
    comparisonFunction?: number,
): TextureSampler
Sets all the parameters of the sampler
Parameters
- OptionalwrapU: number
  u address mode (default: TEXTURE_WRAP_ADDRESSMODE)
- OptionalwrapV: number
  v address mode (default: TEXTURE_WRAP_ADDRESSMODE)
- OptionalwrapR: number
  r address mode (default: TEXTURE_WRAP_ADDRESSMODE)
- OptionalanisotropicFilteringLevel: number
  anisotropic level (default: 1)
- OptionalsamplingMode: number
  sampling mode (default: Constants.TEXTURE_BILINEAR_SAMPLINGMODE)
- OptionalcomparisonFunction: number
  comparison function (default: 0 - no comparison function)
Returns TextureSampler
the current sampler instance
- Defined in .temp/typedoc/docdirectory/doc.d.ts:76240

Class TextureSampler

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TextureSampler

Properties

Optionallabel

samplingMode

Accessors

anisotropicFilteringLevel

Returns Nullable<number>

Parameters

Returns void

comparisonFunction

Returns number

Parameters

Returns void

useMipMaps

Returns boolean

Parameters

Returns void

wrapR

Returns Nullable<number>

Parameters

Returns void

wrapU

Returns Nullable<number>

Parameters

Returns void

wrapV

Returns Nullable<number>

Parameters

Returns void

Methods

compareSampler

Parameters

Returns boolean

setParameters

Parameters

Returns TextureSampler

Settings

On This Page

`Optional`label