JavaFX 24 · javafx.scene.canvas.Canvas · APIdia, the JavaDoc alternative

Canvas is an image that can be drawn on using a set of graphics commands provided by a GraphicsContext.

A Canvas node is constructed with a width and height that specifies the size of the image into which the canvas drawing commands are rendered. All drawing operations are clipped to the bounds of that image.

Example:

import javafx.scene.*;
import javafx.scene.paint.*;
import javafx.scene.canvas.*;

Group root = new Group();
Scene s = new Scene(root, 300, 300, Color.BLACK);

final Canvas canvas = new Canvas(250,250);
GraphicsContext gc = canvas.getGraphicsContext2D();

gc.setFill(Color.BLUE);
gc.fillRect(75,75,100,100);

root.getChildren().add(canvas);

Field Summary

Modifier and Type	Field and Description
private GrowableDataBuffer	current
pack-priv static final int	DEFAULT_OBJ_BUF_SIZE
pack-priv static final int	DEFAULT_VAL_BUF_SIZE
private DoubleProperty	height Defines the height of the canvas.
private int	lastsizeindex
private int[]	recentobjsizes
private int[]	recentvalsizes
private boolean	rendererBehind
private static final int	SIZE_HISTORY
private GraphicsContext	theContext
private DoubleProperty	width Defines the width of the canvas.

Inherited from javafx.scene.Node:: BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Access	Constructor and Description
public	Canvas() Creates an empty instance of Canvas.
public	Canvas(double width of the canvas width, double height of the canvas height) Creates a new instance of Canvas with the given size.

Method Summary

Modifier and Type	Method and Description
private boolean	doComputeContains(double localX, double localY)
private BaseBounds	doComputeGeomBounds(BaseBounds bounds, BaseTransform tx)
private NGNode	doCreatePeer()
private void	doUpdatePeer() Hides javafx.scene.Node.doUpdatePeer.
pack-priv GrowableDataBuffer	getBuffer()
public GraphicsContext	Returns: the `GraphicsContext` associated with this `Canvas` getGraphicsContext2D() returns the `GraphicsContext` associated with this `Canvas`.
public final double	getHeight()
public final double	getWidth()
public final DoubleProperty	heightProperty()
pack-priv boolean	isRendererFallingBehind()
private static int	max(int[] sizes, int defsize)
public final void	setHeight(double value)
public final void	setWidth(double value)
public final DoubleProperty	widthProperty()

Inherited from javafx.scene.Node:: accessibleHelpProperty accessibleRoleDescriptionProperty accessibleRoleProperty accessibleTextProperty addEventFilter addEventHandler applyCss autosize blendModeProperty boundsInLocalProperty boundsInParentProperty buildEventDispatchChain cacheHintProperty cacheProperty clipProperty computeAreaInScreen contains contains cursorProperty depthTestProperty disabledProperty disableProperty effectiveNodeOrientationProperty effectProperty eventDispatcherProperty executeAccessibleAction fireEvent focusedProperty focusTraversableProperty focusVisibleProperty focusWithinProperty getAccessibleHelp getAccessibleRole getAccessibleRoleDescription getAccessibleText getBaselineOffset getBlendMode getBoundsInLocal getBoundsInParent getCacheHint getClassCssMetaData getClip getContentBias getCssMetaData getCursor getDepthTest getEffect getEffectiveNodeOrientation getEventDispatcher getId getInitialCursor getInitialFocusTraversable getInputMethodRequests getLayoutBounds getLayoutX getLayoutY getLocalToParentTransform getLocalToSceneTransform getNodeOrientation getOnContextMenuRequested getOnDragDetected getOnDragDone getOnDragDropped getOnDragEntered getOnDragExited getOnDragOver getOnInputMethodTextChanged getOnKeyPressed getOnKeyReleased getOnKeyTyped getOnMouseClicked getOnMouseDragEntered getOnMouseDragExited getOnMouseDragged getOnMouseDragOver getOnMouseDragReleased getOnMouseEntered getOnMouseExited getOnMouseMoved getOnMousePressed getOnMouseReleased getOnRotate getOnRotationFinished getOnRotationStarted getOnScroll getOnScrollFinished getOnScrollStarted getOnSwipeDown getOnSwipeLeft getOnSwipeRight getOnSwipeUp getOnTouchMoved getOnTouchPressed getOnTouchReleased getOnTouchStationary getOnZoom getOnZoomFinished getOnZoomStarted getOpacity getParent getProperties getPseudoClassStates getRotate getRotationAxis getScaleX getScaleY getScaleZ getScene getStyle getStyleableParent getStyleClass getTransforms getTranslateX getTranslateY getTranslateZ getTypeSelector getUserData getViewOrder hasProperties hoverProperty idProperty inputMethodRequestsProperty intersects intersects isCache isDisable isDisabled isFocused isFocusTraversable isFocusVisible isFocusWithin isHover isManaged isMouseTransparent isPickOnBounds isPressed isResizable isVisible layoutBoundsProperty layoutXProperty layoutYProperty localToParent localToParent localToParent localToParent localToParent localToParentTransformProperty localToScene localToScene localToScene localToScene localToScene localToScene localToScene localToScene localToScene localToScene localToSceneTransformProperty localToScreen localToScreen localToScreen localToScreen localToScreen lookup lookupAll managedProperty maxHeight maxWidth minHeight minWidth mouseTransparentProperty nodeOrientationProperty notifyAccessibleAttributeChanged onContextMenuRequestedProperty onDragDetectedProperty onDragDoneProperty onDragDroppedProperty onDragEnteredProperty onDragExitedProperty onDragOverProperty onInputMethodTextChangedProperty onKeyPressedProperty onKeyReleasedProperty onKeyTypedProperty onMouseClickedProperty onMouseDragEnteredProperty onMouseDragExitedProperty onMouseDraggedProperty onMouseDragOverProperty onMouseDragReleasedProperty onMouseEnteredProperty onMouseExitedProperty onMouseMovedProperty onMousePressedProperty onMouseReleasedProperty onRotateProperty onRotationFinishedProperty onRotationStartedProperty onScrollFinishedProperty onScrollProperty onScrollStartedProperty onSwipeDownProperty onSwipeLeftProperty onSwipeRightProperty onSwipeUpProperty onTouchMovedProperty onTouchPressedProperty onTouchReleasedProperty onTouchStationaryProperty onZoomFinishedProperty onZoomProperty onZoomStartedProperty opacityProperty parentProperty parentToLocal parentToLocal parentToLocal parentToLocal parentToLocal pickOnBoundsProperty prefHeight prefWidth pressedProperty pseudoClassStateChanged queryAccessibleAttribute relocate removeEventFilter removeEventHandler requestFocus requestFocusTraversal resize resizeRelocate rotateProperty rotationAxisProperty scaleXProperty scaleYProperty scaleZProperty sceneProperty sceneToLocal sceneToLocal sceneToLocal sceneToLocal sceneToLocal sceneToLocal sceneToLocal sceneToLocal screenToLocal screenToLocal screenToLocal setAccessibleHelp setAccessibleRole setAccessibleRoleDescription setAccessibleText setBlendMode setCache setCacheHint setClip setCursor setDepthTest setDisable setDisabled setEffect setEventDispatcher setEventHandler setFocused setFocusTraversable setHover setId setInputMethodRequests setLayoutX setLayoutY setManaged setMouseTransparent setNodeOrientation setOnContextMenuRequested setOnDragDetected setOnDragDone setOnDragDropped setOnDragEntered setOnDragExited setOnDragOver setOnInputMethodTextChanged setOnKeyPressed setOnKeyReleased setOnKeyTyped setOnMouseClicked setOnMouseDragEntered setOnMouseDragExited setOnMouseDragged setOnMouseDragOver setOnMouseDragReleased setOnMouseEntered setOnMouseExited setOnMouseMoved setOnMousePressed setOnMouseReleased setOnRotate setOnRotationFinished setOnRotationStarted setOnScroll setOnScrollFinished setOnScrollStarted setOnSwipeDown setOnSwipeLeft setOnSwipeRight setOnSwipeUp setOnTouchMoved setOnTouchPressed setOnTouchReleased setOnTouchStationary setOnZoom setOnZoomFinished setOnZoomStarted setOpacity setPickOnBounds setPressed setRotate setRotationAxis setScaleX setScaleY setScaleZ setStyle setTranslateX setTranslateY setTranslateZ setUserData setViewOrder setVisible snapshot snapshot startDragAndDrop startFullDrag styleProperty toBack toFront toString translateXProperty translateYProperty translateZProperty usesMirroring viewOrderProperty visibleProperty

Field Detail

current	back to summary
private GrowableDataBuffer current

DEFAULT_OBJ_BUF_SIZE	back to summary
pack-priv static final int DEFAULT_OBJ_BUF_SIZE

DEFAULT_VAL_BUF_SIZE	back to summary
pack-priv static final int DEFAULT_VAL_BUF_SIZE

height	back to summary
private DoubleProperty height Defines the height of the canvas. Default Value 0.0

height

back to summary

private DoubleProperty height

Defines the height of the canvas.

Default Value: 0.0

lastsizeindex	back to summary
private int lastsizeindex

recentobjsizes	back to summary
private int[] recentobjsizes

recentvalsizes	back to summary
private int[] recentvalsizes

rendererBehind	back to summary
private boolean rendererBehind

SIZE_HISTORY	back to summary
private static final int SIZE_HISTORY

theContext	back to summary
private GraphicsContext theContext

width	back to summary
private DoubleProperty width Defines the width of the canvas. Default Value 0.0

width

back to summary

private DoubleProperty width

Defines the width of the canvas.

Default Value: 0.0

Constructor Detail

Canvas	back to summary
public Canvas() Creates an empty instance of Canvas.

Canvas	back to summary
public Canvas(double width, double height) Creates a new instance of Canvas with the given size. Parameters width:double width of the canvas height:double height of the canvas

Canvas

back to summary

public Canvas(double width, double height)

Creates a new instance of Canvas with the given size.

Parameters

width:double: width of the canvas
height:double: height of the canvas

Method Detail

doComputeContains	back to summary
private boolean doComputeContains(double localX, double localY)

doComputeGeomBounds	back to summary
private BaseBounds doComputeGeomBounds(BaseBounds bounds, BaseTransform tx)

doCreatePeer	back to summary
private NGNode doCreatePeer()

doUpdatePeer	back to summary
private void doUpdatePeer() Hides javafx.scene.Node.doUpdatePeer.

getBuffer	back to summary
pack-priv GrowableDataBuffer getBuffer()

getGraphicsContext2D back to summary

getGraphicsContext2D	back to summary
public GraphicsContext getGraphicsContext2D() returns the `GraphicsContext` associated with this `Canvas`. Returns:GraphicsContext the `GraphicsContext` associated with this `Canvas`

public GraphicsContext getGraphicsContext2D()

returns the GraphicsContext associated with this Canvas.

Returns:GraphicsContext: the GraphicsContext associated with this Canvas

getHeight	back to summary
public final double getHeight()

getWidth	back to summary
public final double getWidth()

heightProperty	back to summary
public final DoubleProperty heightProperty()

isRendererFallingBehind	back to summary
pack-priv boolean isRendererFallingBehind()

max	back to summary
private static int max(int[] sizes, int defsize)

setHeight	back to summary
public final void setHeight(double value)

setWidth	back to summary
public final void setWidth(double value)

widthProperty	back to summary
public final DoubleProperty widthProperty()

public non-sealed Class Canvas

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail