rápida docs

@rapidajs/three

Table of contents

Enumerations

Classes

Interfaces

Type aliases

Variables

Type aliases

CSSViewParams

Ƭ CSSViewParams: Object

Params for creating a css view

Type declaration

NameTypeDescription
cameraPerspectiveCamera | OrthographicCameraThe camera for the view
sceneSceneThe scene for the view
scissor?ViewRectangleParamsThe scissor for the view. Defaults to the full screen.
viewport?ViewRectangleParamsThe viewport for the view. Defaults to the full screen.
zIndex?numberThe z index for the view. Determines what order the views are rendered in, therefore what layer the view is on. Defaults to zero.

Defined in

packages/three/src/renderer/css/css-view.ts:13

Effect

Ƭ Effect: EffectImpl

Re-exported type for postprocessing effect

Defined in

packages/three/src/postprocessing/types.ts:24

EffectComposerParams

Ƭ EffectComposerParams: Object

Params for creating a new EffectComposer

Type declaration

NameTypeDescription
cameraCamera-
depthBuffer?booleanWhether the effect composer should use a depth buffer default true
frameBufferType?TextureDataTypeThe type of the main frame buffers
multisampling?numberThe number of samples to use for antialiasing default 0
normalPass?booleanWhether a normal pass should be added. default true
rendererWebGLRenderer-
sceneScene-
stencilBuffer?booleanWhether the render target should have a stencil buffer

Defined in

packages/three/src/postprocessing/effect-composer.ts:9

LoadersParams

Ƭ LoadersParams: Object

Params for creating Loaders

Type declaration

NameTypeDescription
dracoDecoderPath?stringAn optional draco decoder path. Defaults to using a CDN - https://www.gstatic.com/draco/v1/decoders/ see docs https://threejs.org/docs/#examples/en/loaders/DRACOLoader

Defined in

packages/three/src/loaders/loaders.ts:23

ViewEventByName

Ƭ ViewEventByName<T>: T extends keyof ViewInteractionEventMap ? ViewInteractionEventMap[T] : Event

Type for a view event name

Type parameters

NameType
Textends string

Defined in

packages/three/src/renderer/view-types.ts:156

ViewInteractionEventName

Ƭ ViewInteractionEventName: "click" | "mousemove" | "mousedown" | "mouseup" | "mouseenter" | "mouseleave" | "mouseout" | "mouseover" | "touchstart" | "touchend" | "touchmove" | "touchcancel"

All supported view interaction events

Defined in

packages/three/src/renderer/view-types.ts:6

ViewInteractionEventSubscription

Ƭ ViewInteractionEventSubscription: Object

A view interaction event subscription that contains a method for unsubscribing

Type declaration

NameType
unsubscribe() => void

Defined in

packages/three/src/renderer/view-types.ts:56

ViewMouseEvent

Ƭ ViewMouseEvent: Object

A mouse event for a webgl view

Type declaration

NameType
dataExtendedMouseEvent
topictypeof VIEW_MOUSE_EVENTS[number]

Defined in

packages/three/src/renderer/view-types.ts:78

ViewRectangle

Ƭ ViewRectangle: Object

A view rectangle given by decimal percentage values

Type declaration

NameType
bottomnumber
heightnumber
leftnumber
widthnumber

Defined in

packages/three/src/renderer/view-types.ts:216

ViewRectangleParam

Ƭ ViewRectangleParam: Object

A view rectangle parameter with a type and value

Type declaration

NameType
typeViewRectangleParamType
valuenumber

Defined in

packages/three/src/renderer/view-types.ts:172

ViewRectangleParamInput

Ƭ ViewRectangleParamInput: string | number | ViewRectangleParam

A ViewParam, which can either be a:

  • decimal percentage (passthrough)
  • number of pixels given by a string '[n]px'
  • percentage of the dom container given by a string '[n]%'
  • percentage of the screen size given by '[n]vw' or '[n]vh'

Defined in

packages/three/src/renderer/view-types.ts:184

ViewRectangleParamPlane

Ƭ ViewRectangleParamPlane: "HORIZONTAL" | "VERTICAL"

Planes that a view rectangle param can be on

Defined in

packages/three/src/renderer/view-types.ts:189

ViewRectangleParamType

Ƭ ViewRectangleParamType: "DECIMAL_PERCENTAGE" | "PIXELS" | "PERCENTAGE" | "VIEWPORT_WIDTH" | "VIEWPORT_HEIGHT"

Supported types for a view rectangle param

Defined in

packages/three/src/renderer/view-types.ts:162

ViewRectangleParams

Ƭ ViewRectangleParams: Object

ViewRectangleParams provides parameters for a view rectangle

Type declaration

NameType
bottom?ViewRectangleParamInput
height?ViewRectangleParamInput
left?ViewRectangleParamInput
right?ViewRectangleParamInput
top?ViewRectangleParamInput
width?ViewRectangleParamInput

Defined in

packages/three/src/renderer/view-types.ts:194

ViewSize

Ƭ ViewSize: Object

The size of a view in pixels

Type declaration

NameType
bottomnumber
heightnumber
leftnumber
widthnumber

Defined in

packages/three/src/renderer/view-types.ts:206

ViewTouch

Ƭ ViewTouch: Touch & { relativeX: number ; relativeY: number }

Defined in

packages/three/src/renderer/view-types.ts:83

ViewTouchEvent

Ƭ ViewTouchEvent: Object

A touch event for a webgl view

Type declaration

NameType
data{ altKey: boolean ; changedTouches: ViewTouch[] ; ctrlKey: boolean ; metaKey: boolean ; shiftKey: boolean ; targetTouches: ViewTouch[] ; touches: ViewTouch[] }
data.altKeyboolean
data.changedTouchesViewTouch[]
data.ctrlKeyboolean
data.metaKeyboolean
data.shiftKeyboolean
data.targetTouchesViewTouch[]
data.touchesViewTouch[]
topictypeof VIEW_MOUSE_EVENTS[number]

Defined in

packages/three/src/renderer/view-types.ts:98

WebGLRendererParams

Ƭ WebGLRendererParams: Object

Params for creating a WebGLRenderer

Type declaration

NameTypeDescription
renderer?WebGLRendererParametersThe three renderer parameters see WebGLRendererParameters

Defined in

packages/three/src/renderer/webgl/webgl-renderer.ts:11

WebGLViewParams

Ƭ WebGLViewParams: Object

Params for creating a webgl view

Type declaration

NameTypeDescription
cameraPerspectiveCamera | OrthographicCameraThe camera for the view
clearDepth?booleanWhether depth should be cleared after rendering this view
effectComposer?Omit<EffectComposerParams, "scene" | "camera" | "renderer">Params for the effect composer
id?stringA unique identifier for the view. Defaults to a uuid if unspecified
sceneSceneThe scene for the view
scissor?ViewRectangleParamsThe scissor for the view. Defaults to the full screen.
useEffectComposer?booleanWhether the view should use an effect composer
viewport?ViewRectangleParamsThe viewport for the view. Defaults to the full screen.
zIndex?numberThe z index for the view. Determines what order the views are rendered in, therefore what layer the view is on. Defaults to zero.

Defined in

packages/three/src/renderer/webgl/webgl-view.ts:26

XRRendererParams

Ƭ XRRendererParams: Object

Params for creating a new VRRenderer

Type declaration

NameTypeDescription
appendButton?booleanWhether a VR/AR button should be appended that will launch on click
cameraPerspectiveCamera | OrthographicCameraThe camera to render with
modeXRRendererModeThe mode for the xr renderer, VR or AR
renderer?WebGLRendererParametersThe three WebGLRenderer to use
sceneSceneThe scene to render

Defined in

packages/three/src/renderer/xr/xr-renderer.ts:35

Variables

Effects

• Const Effects: Object

Factories for creating post processing effects

Type declaration

NameType
bloom(params?: Partial<{ blendFunction: BlendFunction ; opacity: number }> & { blendFunction?: BlendFunction ; height?: number ; intensity?: number ; kernelSize?: any ; luminanceSmoothing?: number ; luminanceThreshold?: number ; width?: number }) => Effect
brightnessContrast(params?: Partial<{ blendFunction: BlendFunction ; opacity: number }> & { blendFunction?: BlendFunction ; brightness?: number ; contrast?: number }) => Effect
chromaticAberration(params: Partial<{ blendFunction: BlendFunction ; opacity: number }> & { blendFunction?: BlendFunction ; offset?: Vector2 }) => Effect
colorAverage(params?: Partial<{ blendFunction: BlendFunction }>) => ColorAverageEffect
colorDepth(params?: Partial<{ blendFunction: BlendFunction ; opacity: number }> & { bits?: number ; blendFunction?: BlendFunction }) => Effect
depth(params?: Partial<{ blendFunction: BlendFunction ; opacity: number }> & { blendFunction?: BlendFunction ; inverted?: boolean }) => Effect
depthOfField(camera: Camera, params?: Partial<{ depthTexture?: { packing: number ; texture: Texture } ; target?: Vector3 }> & { blendFunction?: BlendFunction ; bokehScale?: number ; focalLength?: number ; focusDistance?: number ; height?: number ; width?: number }) => DepthOfFieldEffect
dotScreen(params?: Partial<{ blendFunction: BlendFunction ; opacity: number }> & { angle?: number ; blendFunction?: BlendFunction ; scale?: number }) => Effect
glitch(params?: Partial<{ blendFunction: BlendFunction ; opacity: number }> & { blendFunction?: BlendFunction ; chromaticAberrationOffset?: Vector2 ; columns?: number ; delay?: Vector2 ; dtSize?: number ; duration?: Vector2 ; perturbationMap?: Texture ; ratio?: number ; strength?: Vector2 }) => Effect
godRays(camera: Camera, sun: Mesh<BufferGeometry, Material | Material[]> | Points<BufferGeometry, Material | Material[]>, params?: { blendFunction?: BlendFunction ; blur?: number ; clampMax?: number ; decay?: number ; density?: number ; exposure?: number ; height?: number ; kernelSize?: any ; samples?: number ; weight?: number ; width?: number }) => GodRaysEffect
grid(params?: Partial<{ blendFunction: BlendFunction ; opacity: number }> & Partial<{ blendFunction: BlendFunction ; lineWidth: number ; scale: number }>) => Effect
hueSaturation(params?: Partial<{ blendFunction: BlendFunction ; opacity: number }> & { blendFunction?: BlendFunction ; hue?: number ; saturation?: number }) => Effect
noise(params?: Partial<{ blendFunction: BlendFunction ; opacity: number }> & { blendFunction?: BlendFunction ; premultiply?: boolean }) => Effect
outline(scene: Scene, camera: Camera, params?: Partial<{ selection: Object3D<Event> | Object3D<Event>[] ; selectionLayer: number }> & Partial<{ blendFunction: BlendFunction ; blur: boolean ; edgeStrength: number ; height: number ; hiddenEdgeColor: number ; kernelSize: KernelSize ; patternTexture: number ; pulseSpeed: number ; visibleEdgeColor: number ; width: number ; xRay: boolean }>) => OutlineEffect
pixelation(params?: Partial<{ granularity: number }>) => PixelationEffect
scanline(params?: Partial<{ blendFunction: BlendFunction ; opacity: number }> & { blendFunction?: BlendFunction ; density?: number }) => Effect
sepia(params?: Partial<{ blendFunction: BlendFunction ; opacity: number }> & { blendFunction?: BlendFunction ; intensity?: number }) => Effect
ssao(camera: Camera, normalPass: NormalPass, params?: { bias?: number ; blendFunction?: BlendFunction ; color?: null | string ; distanceFalloff?: number ; distanceThreshold?: number ; intensity?: number ; luminanceInfluence?: number ; radius?: number ; rangeFalloff?: number ; rangeThreshold?: number ; rings?: number ; samples?: number ; scale?: number }) => SSAOEffect
toneMapping(params?: Partial<{ blendFunction: BlendFunction ; opacity: number }> & { adaptationRate?: number ; adaptive?: boolean ; averageLuminance?: number ; blendFunction?: BlendFunction ; maxLuminance?: number ; middleGrey?: number ; resolution?: number }) => Effect
vignette(params?: Partial<{ blendFunction: BlendFunction ; opacity: number }> & { blendFunction?: BlendFunction ; darkness?: number ; eskil?: boolean ; offset?: number }) => Effect

Defined in

packages/three/src/postprocessing/effects.ts:29

VIEW_ALL_EVENT_NAMES

• Const VIEW_ALL_EVENT_NAMES: ViewInteractionEventName[]

Defined in

packages/three/src/renderer/view-types.ts:20

VIEW_MOUSE_EVENTS

• Const VIEW_MOUSE_EVENTS: string[]

Defined in

packages/three/src/renderer/view-types.ts:35

VIEW_TOUCH_EVENTS

• Const VIEW_TOUCH_EVENTS: string[]

Defined in

packages/three/src/renderer/view-types.ts:46