Class TextureSampler

constructor

• new TextureSampler(): TextureSampler

  Creates a Sampler instance

  Returns TextureSampler

Optionallabel

samplingMode

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>

• set anisotropicFilteringLevel(value: Nullable<number>): void

  Parameters

  • value: Nullable<number>

  Returns void

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

• set comparisonFunction(value: number): void

  Parameters

  • value: number

  Returns void

useMipMaps

• get useMipMaps(): Nullable<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 Nullable<boolean>

• set useMipMaps(value: Nullable<boolean>): void

  Parameters

  • value: Nullable<boolean>

  Returns void

wrapR

• get wrapR(): Nullable<number>

  Value	Type	Description
  0	CLAMP_ADDRESSMODE
  1	WRAP_ADDRESSMODE
  2	MIRROR_ADDRESSMODE

  Returns Nullable<number>

• set wrapR(value: Nullable<number>): void

  Parameters

  • value: Nullable<number>

  Returns void

wrapU

• get wrapU(): Nullable<number>

  Value	Type	Description
  0	CLAMP_ADDRESSMODE
  1	WRAP_ADDRESSMODE
  2	MIRROR_ADDRESSMODE

  Returns Nullable<number>

• set wrapU(value: Nullable<number>): void

  Parameters

  • value: Nullable<number>

  Returns void

wrapV

• get wrapV(): Nullable<number>

  Value	Type	Description
  0	CLAMP_ADDRESSMODE
  1	WRAP_ADDRESSMODE
  2	MIRROR_ADDRESSMODE

  Returns Nullable<number>

• set wrapV(value: Nullable<number>): void

  Parameters

  • value: Nullable<number>

  Returns void

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

setParameters

• setParameters(
      wrapU?: number,
      wrapV?: number,
      wrapR?: number,
      anisotropicFilteringLevel?: number,
      samplingMode?: number,
      comparisonFunction?: number,
  ): TextureSampler

  Sets all the parameters of the sampler

  Parameters

  • wrapU: number = Constants.TEXTURE_WRAP_ADDRESSMODE

    u address mode (default: TEXTURE_WRAP_ADDRESSMODE)

  • wrapV: number = Constants.TEXTURE_WRAP_ADDRESSMODE

    v address mode (default: TEXTURE_WRAP_ADDRESSMODE)

  • wrapR: number = Constants.TEXTURE_WRAP_ADDRESSMODE

    r address mode (default: TEXTURE_WRAP_ADDRESSMODE)

  • anisotropicFilteringLevel: number = 1

    anisotropic level (default: 1)

  • samplingMode: number = Constants.TEXTURE_BILINEAR_SAMPLINGMODE

    sampling mode (default: Constants.TEXTURE_BILINEAR_SAMPLINGMODE)

  • comparisonFunction: number = 0

    comparison function (default: 0 - no comparison function)

  Returns TextureSampler

  the current sampler instance