Class RedGPUContext

RedGPU.initialize 실행이후 생성 제공되는 객체.

WebGPU 초기화시 얻어낸 기본 정보들을 속성으로 가진다
View3D 객체를 소유하며 실제 최상위 컨테이너 역활을 한다.

Hierarchy (View Summary)

RedGPUContextViewContainer
- RedGPUContext

Constructors

constructor

new RedGPUContext(
    htmlCanvas: HTMLCanvasElement,
    gpuAdapter: GPUAdapter,
    gpuDevice: GPUDevice,
    gpuContext: GPUCanvasContext,
    alphaMode: GPUCanvasAlphaMode,
): RedGPUContext
Parameters
- htmlCanvas: HTMLCanvasElement
- gpuAdapter: GPUAdapter
- gpuDevice: GPUDevice
- gpuContext: GPUCanvasContext
- alphaMode: GPUCanvasAlphaMode
Returns RedGPUContext
Overrides RedGPUContextViewContainer.constructor
- Defined in src/context/RedGPUContext.ts:34

Properties

currentRequestAnimationFrame

currentRequestAnimationFrame: number

currentTime

currentTime: number

onResize

onResize: (width: number, height: number) => void = null

Accessors

alphaMode

get alphaMode(): GPUCanvasAlphaMode
Retrieves the alpha mode of the GPUCanvas object.

Returns GPUCanvasAlphaMode
The alpha mode of the GPUCanvas.
- Defined in src/context/RedGPUContext.ts:118
set alphaMode(value: GPUCanvasAlphaMode): void
Sets the alpha mode of the GPUCanvas.
Parameters
- value: GPUCanvasAlphaMode
  The new alpha mode value to be set.
Returns void
- Defined in src/context/RedGPUContext.ts:127

antialiasingManager

get antialiasingManager(): AntialiasingManager
Returns AntialiasingManager
- Defined in src/context/RedGPUContext.ts:54

backgroundColor

get backgroundColor(): ColorRGBA
Get the background color.

Returns ColorRGBA
The background color.
- Defined in src/context/RedGPUContext.ts:71
set backgroundColor(value: ColorRGBA): void
Sets the background color of the element.
Parameters
- value: ColorRGBA
  The color value to set as the background color.
Returns void
Throws
If the value parameter is not an instance of ColorRGBA.
- Defined in src/context/RedGPUContext.ts:81

configurationDescription

get configurationDescription(): GPUCanvasConfiguration
Retrieves the GPU canvas configuration description.

Returns GPUCanvasConfiguration
The configuration description.
- Defined in src/context/RedGPUContext.ts:100

detector

get detector(): RedGPUContextDetector
Retrieves the RedGPUContextDetector instance.

Returns RedGPUContextDetector
The RedGPUContextDetector instance.
- Defined in src/context/RedGPUContext.ts:91

gpuAdapter

get gpuAdapter(): GPUAdapter
Retrieves the GPU adapter.

Returns GPUAdapter
The GPU adapter object.
- Defined in src/context/RedGPUContext.ts:109

gpuContext

get gpuContext(): GPUCanvasContext
Returns the GPU canvas context.

Returns GPUCanvasContext
The GPU canvas context.
- Defined in src/context/RedGPUContext.ts:137

gpuDevice

get gpuDevice(): GPUDevice
Retrieves the GPU device associated with this object.

Returns GPUDevice
The GPU device.
- Defined in src/context/RedGPUContext.ts:146

height

get height(): string | number
Retrieves the height of the sizeManager.

Returns string | number
The height of the sizeManager.
- Defined in src/context/RedGPUContext.ts:208
set height(value: string | number): void
Sets the height value of the element.
Parameters
- value: string | number
  The height value to set. It can be either a number or a string.
Returns void
- Defined in src/context/RedGPUContext.ts:217

htmlCanvas

get htmlCanvas(): HTMLCanvasElement
Retrieves the HTML canvas element associated with the current instance of the class.

Returns HTMLCanvasElement
The HTML canvas element.
- Defined in src/context/RedGPUContext.ts:155

keyboardKeyBuffer

get keyboardKeyBuffer(): { [p: string]: boolean }
Returns { [p: string]: boolean }
- Defined in src/context/RedGPUContext.ts:159
set keyboardKeyBuffer(value: { [p: string]: boolean }): void
Parameters
- value: { [p: string]: boolean }
Returns void
- Defined in src/context/RedGPUContext.ts:163

numViews

get numViews(): number
Returns the number of View3D objects owned by this object.

Returns number
The number of View3D objects.
Inherited from RedGPUContextViewContainer.numViews
- Defined in src/context/core/RedGPUContextViewContainer.ts:40

renderScale

get renderScale(): number
Retrieves the render scale value from the size manager.

Returns number
The render scale value.
- Defined in src/context/RedGPUContext.ts:230
set renderScale(value: number): void
Sets the render scale for the size manager.
Parameters
- value: number
  The render scale value to set.
Returns void
- Defined in src/context/RedGPUContext.ts:239

resourceManager

get resourceManager(): ResourceManager
Returns the resource manager.

Returns ResourceManager
The resource manager object.
- Defined in src/context/RedGPUContext.ts:172

screenRectObject

get screenRectObject(): { height: number; width: number; x: number; y: number }
Returns { height: number; width: number; x: number; y: number }
- Defined in src/context/RedGPUContext.ts:221

sizeManager

get sizeManager(): RedGPUContextSizeManager
Retrieves the size manager of the RedGPU context.

Returns RedGPUContextSizeManager
The size manager of the RedGPU context.
- Defined in src/context/RedGPUContext.ts:181

useDebugPanel

get useDebugPanel(): boolean
Returns boolean
- Defined in src/context/RedGPUContext.ts:58
set useDebugPanel(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/context/RedGPUContext.ts:62

viewList

get viewList(): View3D[]
Returns the list of View3D objects owned by this instance.

Returns View3D[]
The list of View3D objects.
Inherited from RedGPUContextViewContainer.viewList
- Defined in src/context/core/RedGPUContextViewContainer.ts:31

width

get width(): string | number
Retrieves the width of the object.

Returns string | number
The width of the object.
- Defined in src/context/RedGPUContext.ts:190
set width(value: string | number): void
Sets the width value for the size manager.
Parameters
- value: string | number
  The width value to set. It can be either a number or a string.
Returns void
- Defined in src/context/RedGPUContext.ts:199

Methods

addView

addView(view: View3D): void
Adds a view to the view list.
Parameters
- view: View3D
  The view to be added.
Returns void
Inherited from RedGPUContextViewContainer.addView
- Defined in src/context/core/RedGPUContextViewContainer.ts:59

addViewAt

addViewAt(view: View3D, index: number): void
Adds a view at a specified index in the view list.
Parameters
- view: View3D
  The view to be added.
- index: number
  The index at which the view should be inserted.
Returns void
Inherited from RedGPUContextViewContainer.addViewAt
- Defined in src/context/core/RedGPUContextViewContainer.ts:71

contains

contains(child: View3D): boolean
Checks if the given child View3D is contained within the current View3D.
Parameters
- child: View3D
  The child View3D to check for containment.
Returns boolean
- Returns true if the child View3D is contained, otherwise false.
Inherited from RedGPUContextViewContainer.contains
- Defined in src/context/core/RedGPUContextViewContainer.ts:49

destroy

destroy(): void
Destroys the GPU device. It releases any allocated resources and cleans up the GPU device.

Returns void
- Defined in src/context/RedGPUContext.ts:252

getViewAt

getViewAt(index: number): View3D
Retrieves the view at the specified index.
Parameters
- index: number
  The index of the view to retrieve.
Returns View3D
The view at the specified index.
Inherited from RedGPUContextViewContainer.getViewAt
- Defined in src/context/core/RedGPUContextViewContainer.ts:86

getViewIndex

getViewIndex(view: View3D): number
Returns the index of the specified view in the view list.
Parameters
- view: View3D
  The view to search for.
Returns number
- The index of the view in the view list. Returns -1 if the view is not found.
Inherited from RedGPUContextViewContainer.getViewIndex
- Defined in src/context/core/RedGPUContextViewContainer.ts:97

removeAllViews

removeAllViews(): void
Removes all views from the view list.

Returns void
Inherited from RedGPUContextViewContainer.removeAllViews
- Defined in src/context/core/RedGPUContextViewContainer.ts:194

removeView

removeView(view: View3D): void
Removes a view from the view list.
Parameters
- view: View3D
  The view to be removed.
Returns void
Inherited from RedGPUContextViewContainer.removeView
- Defined in src/context/core/RedGPUContextViewContainer.ts:167

removeViewAt

removeViewAt(index: number): void
Removes the view at the specified index from the view list.
Parameters
- index: number
  The index of the view to remove.
Returns void
Throws
- Throws an error if the index is out of range.
Inherited from RedGPUContextViewContainer.removeViewAt
- Defined in src/context/core/RedGPUContextViewContainer.ts:180

setSize

setSize(w?: string | number, h?: string | number): void
Sets the size of the element.
Parameters
- Optionalw: string | number = ...
  The width of the element. It can be either a string or a number. Defaults to the current width.
- Optionalh: string | number = ...
  The height of the element. It can be either a string or a number. Defaults to the current height.
Returns void
- Defined in src/context/RedGPUContext.ts:263

setViewIndex

setViewIndex(view: View3D, index: number): void
Sets the view at the specified index in the viewList of the RedGPUContext instance.
Parameters
- view: View3D
  The View3D instance to set at the specified index.
- index: number
  The index at which to set the view.
Returns void
Throws
If the input view is not registered in the RedGPUContext instance.

Throws
If the index is out of bounds, i.e., greater than or equal to the length of viewList.
Inherited from RedGPUContextViewContainer.setViewIndex
- Defined in src/context/core/RedGPUContextViewContainer.ts:110

swapViews

swapViews(view1: View3D, view2: View3D): void
Swaps the positions of two views in the view list of the RedGPUContext instance.
Parameters
- view1: View3D
  The first view to be swapped.
- view2: View3D
  The second view to be swapped.
Returns void
Throws
If either view1 or view2 is not an instance of the View3D class.

Throws
If either view1 or view2 is not a child of this RedGPUContext instance.
Inherited from RedGPUContextViewContainer.swapViews
- Defined in src/context/core/RedGPUContextViewContainer.ts:133

swapViewsAt

swapViewsAt(index1: number, index2: number): void
Swaps two views at the specified indices in the view list.
Parameters
- index1: number
  The index of the first view to swap.
- index2: number
  The index of the second view to swap.
Returns void
Throws
- If either index1 or index2 is not a positive integer. If either index1 or index2 is larger than or equal to the length of the view list.
Inherited from RedGPUContextViewContainer.swapViewsAt
- Defined in src/context/core/RedGPUContextViewContainer.ts:150

Class RedGPUContext

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RedGPUContext

Properties

currentRequestAnimationFrame

currentTime

onResize

Accessors

alphaMode

Returns GPUCanvasAlphaMode

Parameters

Returns void

antialiasingManager

Returns AntialiasingManager

backgroundColor

Returns ColorRGBA

Parameters

Returns void

Throws

configurationDescription

Returns GPUCanvasConfiguration

detector

Returns RedGPUContextDetector

gpuAdapter

Returns GPUAdapter

gpuContext

Returns GPUCanvasContext

gpuDevice

Returns GPUDevice

height

Returns string | number

Parameters

Returns void

htmlCanvas

Returns HTMLCanvasElement

keyboardKeyBuffer

Returns { [p: string]: boolean }

Parameters

Returns void

numViews

Returns number

renderScale

Returns number

Parameters

Returns void

resourceManager

Returns ResourceManager

screenRectObject

Returns { height: number; width: number; x: number; y: number }

sizeManager

Returns RedGPUContextSizeManager

useDebugPanel

Returns boolean

Parameters

Returns void

viewList

Returns View3D[]

width

Returns string | number

Parameters

Returns void

Methods

addView

Parameters

Returns void

addViewAt

Parameters

Returns void

contains

Parameters

Returns boolean

destroy