Class Sampler

Class representing a sampler for GPU textures.

Hierarchy (View Summary)

ResourceBase
- Sampler

Index

Constructors

Accessors

addressModeU addressModeV addressModeW cacheKey gpuDevice gpuSampler isAnisotropyValid magFilter maxAnisotropy minFilter mipmapFilter name redGPUContext resourceManagerKey uuid

Methods

__addDirtyPipelineListener __fireListenerList __removeDirtyPipelineListener

Constructors

constructor

new Sampler(
redGPUContext: RedGPUContext,
options?: GPUSamplerDescriptor,
): Sampler
Parameters
- redGPUContext: RedGPUContext
- Optionaloptions: GPUSamplerDescriptor
Returns Sampler
Overrides ResourceBase.constructor
- Defined in src/resources/sampler/Sampler.ts:37

Accessors

addressModeU

get addressModeU(): GPUAddressMode
Returns GPUAddressMode
- Defined in src/resources/sampler/Sampler.ts:42
set addressModeU(value: GPUAddressMode): void
Parameters
- value: GPUAddressMode
Returns void
- Defined in src/resources/sampler/Sampler.ts:46

addressModeV

get addressModeV(): GPUAddressMode
Returns GPUAddressMode
- Defined in src/resources/sampler/Sampler.ts:50
set addressModeV(value: GPUAddressMode): void
Parameters
- value: GPUAddressMode
Returns void
- Defined in src/resources/sampler/Sampler.ts:54

addressModeW

get addressModeW(): GPUAddressMode
Returns GPUAddressMode
- Defined in src/resources/sampler/Sampler.ts:58
set addressModeW(value: GPUAddressMode): void
Parameters
- value: GPUAddressMode
Returns void
- Defined in src/resources/sampler/Sampler.ts:62

cacheKey

get cacheKey(): string
Returns string
Inherited from ResourceBase.cacheKey
- Defined in src/resources/ResourceBase.ts:39
set cacheKey(value: string): void
Parameters
- value: string
Returns void
Inherited from ResourceBase.cacheKey
- Defined in src/resources/ResourceBase.ts:43

gpuDevice

get gpuDevice(): GPUDevice
Retrieves the GPU device associated with the current instance.

Returns GPUDevice
The GPU device.
Inherited from ResourceBase.gpuDevice
- Defined in src/resources/ResourceBase.ts:73

gpuSampler

get gpuSampler(): GPUSampler
Retrieves the GPU sampler associated with the current instance.

Returns GPUSampler
The GPU sampler.
- Defined in src/resources/sampler/Sampler.ts:89

isAnisotropyValid

get isAnisotropyValid(): boolean
Returns boolean
- Defined in src/resources/sampler/Sampler.ts:151

magFilter

get magFilter(): GPUFilterMode
Retrieves the magnification filter mode used by the GPU.

Returns GPUFilterMode
The magnification filter mode.
- Defined in src/resources/sampler/Sampler.ts:98
set magFilter(value: GPUFilterMode): void
Sets the magnification filter mode for the GPU texture.
Parameters
- value: GPUFilterMode
  The magnification filter mode to be set.
Returns void
- Defined in src/resources/sampler/Sampler.ts:107

maxAnisotropy

get maxAnisotropy(): number
Retrieves the maximum anisotropy value.

Returns number
The maximum anisotropy value.
- Defined in src/resources/sampler/Sampler.ts:134
set maxAnisotropy(value: number): void
Set the maximum anisotropy value for the sampler.
Parameters
- value: number
  The value to set as maximum anisotropy. Must be within the range of 1 to 16.
Returns void
Throws
If the value is not within the specified range.
- Defined in src/resources/sampler/Sampler.ts:145

minFilter

get minFilter(): GPUFilterMode
Returns the minimum filter mode for the GPU filter.

Returns GPUFilterMode
The minimum filter mode for the GPU filter.
- Defined in src/resources/sampler/Sampler.ts:116
set minFilter(value: GPUFilterMode): void
Sets the value of minFilter.
Parameters
- value: GPUFilterMode
  The new value for minFilter.
Returns void
- Defined in src/resources/sampler/Sampler.ts:125

mipmapFilter

get mipmapFilter(): GPUMipmapFilterMode
Returns the MipmapFilter mode of the GPU object.

Returns GPUMipmapFilterMode
The MipmapFilter mode of the GPU.
- Defined in src/resources/sampler/Sampler.ts:71
set mipmapFilter(value: GPUMipmapFilterMode): void
Sets the mipmap filter mode.
Parameters
- value: GPUMipmapFilterMode
  The filter mode to be set.
Returns void
- Defined in src/resources/sampler/Sampler.ts:80

name

get name(): string
Returns string
Inherited from ResourceBase.name
- Defined in src/resources/ResourceBase.ts:51
set name(value: string): void
Parameters
- value: string
Returns void
Inherited from ResourceBase.name
- Defined in src/resources/ResourceBase.ts:56

redGPUContext

get redGPUContext(): RedGPUContext
Retrieves the RedGPUContext instance.

Returns RedGPUContext
The RedGPUContext instance.
Inherited from ResourceBase.redGPUContext
- Defined in src/resources/ResourceBase.ts:82

resourceManagerKey

get resourceManagerKey(): string
Returns string
Inherited from ResourceBase.resourceManagerKey
- Defined in src/resources/ResourceBase.ts:47

uuid

get uuid(): string
Retrieves the UUID of the object.

Returns string
The UUID of the object.
Inherited from ResourceBase.uuid
- Defined in src/resources/ResourceBase.ts:65

Methods

__addDirtyPipelineListener

__addDirtyPipelineListener(listener: () => void): void
Adds a listener function to the dirty pipeline listeners array. This function will be called when the pipeline becomes dirty.
Parameters
- listener: () => void
  The listener function to be added.
Returns void
Inherited from ResourceBase.__addDirtyPipelineListener
- Defined in src/resources/ResourceBase.ts:92

__fireListenerList

__fireListenerList(resetList?: boolean): void
Fires the dirty listeners list.
Parameters
- OptionalresetList: boolean = false
  Indicates whether to reset the dirty listeners list after firing.
Returns void
Inherited from ResourceBase.__fireListenerList
- Defined in src/resources/ResourceBase.ts:115

__removeDirtyPipelineListener

__removeDirtyPipelineListener(listener: () => void): void
Removes a dirty pipeline listener from the list of listeners.
Parameters
- listener: () => void
  The listener function to be removed.
Returns void
Inherited from ResourceBase.__removeDirtyPipelineListener
- Defined in src/resources/ResourceBase.ts:102

Class Sampler

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Sampler

Accessors

addressModeU

Returns GPUAddressMode

Parameters

Returns void

addressModeV

Returns GPUAddressMode

Parameters

Returns void

addressModeW

Returns GPUAddressMode

Parameters

Returns void

cacheKey

Returns string

Parameters

Returns void

gpuDevice

Returns GPUDevice

gpuSampler

Returns GPUSampler

isAnisotropyValid

Returns boolean

magFilter

Returns GPUFilterMode

Parameters

Returns void

maxAnisotropy

Returns number

Parameters

Returns void

Throws

minFilter

Returns GPUFilterMode

Parameters

Returns void

mipmapFilter

Returns GPUMipmapFilterMode

Parameters

Returns void

name

Returns string

Parameters

Returns void

redGPUContext

Returns RedGPUContext

resourceManagerKey

Returns string

uuid

Returns string

Methods

__addDirtyPipelineListener

Parameters

Returns void

__fireListenerList

Parameters

Returns void

__removeDirtyPipelineListener

Parameters

Returns void

Settings

On This Page