Class GraphicsContext

Graphics context for handling a p5.Graphics instance.

Since

2.0.0

Hierarchy (View Summary)

Context
- GraphicsContext

Index

Constructors

constructor

new GraphicsContext(config: ContextConfig): GraphicsContext
The constructor for the GraphicsContext class.
Parameters
- config: ContextConfig
  {ContextConfig} - The configuration for the context.
Returns GraphicsContext
Since
2.0.0
Overrides Context.constructor
- Defined in sketch/graphics/graphics-context.ts:52

Accessors

`Static`MIN_RESOLUTION

get MIN_RESOLUTION(): number
Returns number
The minimum resolution for a context.

Since
2.0.0
Inherited from Context.MIN_RESOLUTION
- Defined in sketch/context/context.ts:114

aspectRatio

get aspectRatio(): AspectRatio
Returns AspectRatio
The AspectRatio of the context.

Since
2.0.0
Inherited from Context.aspectRatio
- Defined in sketch/context/context.ts:161
set aspectRatio(aspectRatio: AspectRatio): void
Protected
Set the AspectRatio of the context.
Parameters
- aspectRatio: AspectRatio
  {AspectRatio} - The new AspectRatio of the context.
Returns void
Inherited from Context.aspectRatio
- Defined in sketch/context/context.ts:172

center

get center(): Vector
Returns Vector
The center of the context.

Since
2.0.0
Inherited from Context.center
- Defined in sketch/context/context.ts:257

COORDINATE_MAPPER

get COORDINATE_MAPPER(): CoordinateRatioMapper
Returns CoordinateRatioMapper
The CoordinateRatioMapper for the context.

Since
2.0.0
Inherited from Context.COORDINATE_MAPPER
- Defined in sketch/context/context.ts:123

defaultStrokeWeight

get defaultStrokeWeight(): number
The default stroke weight for the context. Equivalent to a stroke of 1 in a 500x500 sketch.

Returns number
The default stroke weight for the context.

Since
2.0.0
Inherited from Context.defaultStrokeWeight
- Defined in sketch/context/context.ts:186

GRAPHICS

get GRAPHICS(): Graphics
Returns Graphics
The p5.Graphics instance backing this context.

Since
2.0.0
- Defined in sketch/graphics/graphics-context.ts:101

height

get height(): number
Returns number
The height of the context.

Since
2.0.0
Inherited from Context.height
- Defined in sketch/context/context.ts:248

IS_WEBGL

get IS_WEBGL(): boolean
Is the context in WebGL mode?

Returns boolean
true if the context is in WebGL mode, false otherwise.

Since
2.0.0
Inherited from Context.IS_WEBGL
- Defined in sketch/context/context.ts:134

matchContainerRatio

get matchContainerRatio(): boolean
Should the aspect ratio of the context match the aspect ratio of its container?

Returns boolean
Whether the aspect ratio should match the container aspect ratio.

Since
2.0.0
Inherited from Context.matchContainerRatio
- Defined in sketch/context/context.ts:197
set matchContainerRatio(matchContainerRatio: boolean): void
Should the aspect ratio of the context match the aspect ratio of its container?
Parameters
- matchContainerRatio: boolean
  {boolean} - The new value for the matchContainerRatio property.
Returns void
Since
2.0.0
Inherited from Context.matchContainerRatio
- Defined in sketch/context/context.ts:208

NAME

get NAME(): string
Returns string
The name of the context.

Since
2.0.0
Overrides Context.NAME
- Defined in sketch/graphics/graphics-context.ts:61

RENDER_TYPE

get RENDER_TYPE(): RenderType
Returns RenderType
The RenderType of the context.

Since
2.0.0
Inherited from Context.RENDER_TYPE
- Defined in sketch/context/context.ts:152

resolution

get resolution(): number
Returns number
The resolution of the context.

Since
2.0.0
Inherited from Context.resolution
- Defined in sketch/context/context.ts:217
set resolution(resolution: number): void
Protected
Set the resolution of the context.
Parameters
- resolution: number
  {number} - The new resolution of the context.
Returns void
Inherited from Context.resolution
- Defined in sketch/context/context.ts:228

width

get width(): number
Returns number
The width of the context.

Since
2.0.0
Inherited from Context.width
- Defined in sketch/context/context.ts:239

Methods

resize

resize(): void
Resize the context.

Returns void
Since
2.0.0
Overrides Context.resize
- Defined in sketch/graphics/graphics-context.ts:73

updateAspectRatio

updateAspectRatio(aspectRatio: AspectRatio): void
Update the AspectRatio of the context.
Parameters
- aspectRatio: AspectRatio
  {AspectRatio} - The new AspectRatio of the context.
Returns void
Since
2.0.0
Overrides Context.updateAspectRatio
- Defined in sketch/graphics/graphics-context.ts:82

updateResolution

updateResolution(resolution: number): void
Update the resolution of the context.
Parameters
- resolution: number
  {number} - The new resolution of the context.
Returns void
Since
2.0.0
Overrides Context.updateResolution
- Defined in sketch/graphics/graphics-context.ts:91

Class GraphicsContext

Since

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns GraphicsContext

Since

Accessors

StaticMIN_RESOLUTION

Returns number

Since

aspectRatio

Returns AspectRatio

Since

Parameters

Returns void

center

Returns Vector

Since

COORDINATE_MAPPER

Returns CoordinateRatioMapper

Since

defaultStrokeWeight

Returns number

Since

GRAPHICS

Returns Graphics

Since

height

Returns number

Since

IS_WEBGL

Returns boolean

Since

matchContainerRatio

Returns boolean

Since

Parameters

Returns void

Since

NAME

Returns string

Since

RENDER_TYPE

Returns RenderType

Since

resolution

Returns number

Since

Parameters

Returns void

width

Returns number

Since

Methods

resize

Returns void

Since

updateAspectRatio

Parameters

Returns void

Since

updateResolution

Parameters

Returns void

Since

Settings

On This Page

`Static`MIN_RESOLUTION