Struct web_sys::CanvasRenderingContext2d
source · [−]#[repr(transparent)]pub struct CanvasRenderingContext2d { /* private fields */ }
Expand description
The CanvasRenderingContext2d
class.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Implementations
Getter for the canvas
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, HtmlCanvasElement
Getter for the globalAlpha
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the globalAlpha
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the globalCompositeOperation
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the globalCompositeOperation
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the strokeStyle
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the strokeStyle
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the fillStyle
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the fillStyle
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the filter
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the filter
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the imageSmoothingEnabled
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the imageSmoothingEnabled
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the lineWidth
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the lineWidth
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the lineCap
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the lineCap
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the lineJoin
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the lineJoin
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the miterLimit
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the miterLimit
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the lineDashOffset
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the lineDashOffset
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the shadowOffsetX
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the shadowOffsetX
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the shadowOffsetY
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the shadowOffsetY
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the shadowBlur
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the shadowBlur
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the shadowColor
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the shadowColor
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the font
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the font
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the textAlign
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the textAlign
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Getter for the textBaseline
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Setter for the textBaseline
field of this object.
This API requires the following crate features to be activated: CanvasRenderingContext2d
pub fn draw_image_with_html_image_element(
&self,
image: &HtmlImageElement,
dx: f64,
dy: f64
) -> Result<(), JsValue>
pub fn draw_image_with_html_image_element(
&self,
image: &HtmlImageElement,
dx: f64,
dy: f64
) -> Result<(), JsValue>
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, HtmlImageElement
pub fn draw_image_with_svg_image_element(
&self,
image: &SvgImageElement,
dx: f64,
dy: f64
) -> Result<(), JsValue>
pub fn draw_image_with_svg_image_element(
&self,
image: &SvgImageElement,
dx: f64,
dy: f64
) -> Result<(), JsValue>
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, SvgImageElement
pub fn draw_image_with_html_canvas_element(
&self,
image: &HtmlCanvasElement,
dx: f64,
dy: f64
) -> Result<(), JsValue>
pub fn draw_image_with_html_canvas_element(
&self,
image: &HtmlCanvasElement,
dx: f64,
dy: f64
) -> Result<(), JsValue>
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, HtmlCanvasElement
pub fn draw_image_with_html_video_element(
&self,
image: &HtmlVideoElement,
dx: f64,
dy: f64
) -> Result<(), JsValue>
pub fn draw_image_with_html_video_element(
&self,
image: &HtmlVideoElement,
dx: f64,
dy: f64
) -> Result<(), JsValue>
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, HtmlVideoElement
pub fn draw_image_with_image_bitmap(
&self,
image: &ImageBitmap,
dx: f64,
dy: f64
) -> Result<(), JsValue>
pub fn draw_image_with_image_bitmap(
&self,
image: &ImageBitmap,
dx: f64,
dy: f64
) -> Result<(), JsValue>
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, ImageBitmap
pub fn draw_image_with_html_image_element_and_dw_and_dh(
&self,
image: &HtmlImageElement,
dx: f64,
dy: f64,
dw: f64,
dh: f64
) -> Result<(), JsValue>
pub fn draw_image_with_html_image_element_and_dw_and_dh(
&self,
image: &HtmlImageElement,
dx: f64,
dy: f64,
dw: f64,
dh: f64
) -> Result<(), JsValue>
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, HtmlImageElement
pub fn draw_image_with_svg_image_element_and_dw_and_dh(
&self,
image: &SvgImageElement,
dx: f64,
dy: f64,
dw: f64,
dh: f64
) -> Result<(), JsValue>
pub fn draw_image_with_svg_image_element_and_dw_and_dh(
&self,
image: &SvgImageElement,
dx: f64,
dy: f64,
dw: f64,
dh: f64
) -> Result<(), JsValue>
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, SvgImageElement
pub fn draw_image_with_html_canvas_element_and_dw_and_dh(
&self,
image: &HtmlCanvasElement,
dx: f64,
dy: f64,
dw: f64,
dh: f64
) -> Result<(), JsValue>
pub fn draw_image_with_html_canvas_element_and_dw_and_dh(
&self,
image: &HtmlCanvasElement,
dx: f64,
dy: f64,
dw: f64,
dh: f64
) -> Result<(), JsValue>
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, HtmlCanvasElement
pub fn draw_image_with_html_video_element_and_dw_and_dh(
&self,
image: &HtmlVideoElement,
dx: f64,
dy: f64,
dw: f64,
dh: f64
) -> Result<(), JsValue>
pub fn draw_image_with_html_video_element_and_dw_and_dh(
&self,
image: &HtmlVideoElement,
dx: f64,
dy: f64,
dw: f64,
dh: f64
) -> Result<(), JsValue>
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, HtmlVideoElement
pub fn draw_image_with_image_bitmap_and_dw_and_dh(
&self,
image: &ImageBitmap,
dx: f64,
dy: f64,
dw: f64,
dh: f64
) -> Result<(), JsValue>
pub fn draw_image_with_image_bitmap_and_dw_and_dh(
&self,
image: &ImageBitmap,
dx: f64,
dy: f64,
dw: f64,
dh: f64
) -> Result<(), JsValue>
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, ImageBitmap
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, HtmlImageElement
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, SvgImageElement
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, HtmlCanvasElement
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, HtmlVideoElement
The drawImage()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, ImageBitmap
The beginPath()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The clip()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The clip()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, CanvasWindingRule
The clip()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, Path2d
The clip()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, CanvasWindingRule
, Path2d
The fill()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The fill()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, CanvasWindingRule
The fill()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, Path2d
The fill()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, CanvasWindingRule
, Path2d
The isPointInPath()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
pub fn is_point_in_path_with_f64_and_canvas_winding_rule(
&self,
x: f64,
y: f64,
winding: CanvasWindingRule
) -> bool
pub fn is_point_in_path_with_f64_and_canvas_winding_rule(
&self,
x: f64,
y: f64,
winding: CanvasWindingRule
) -> bool
The isPointInPath()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, CanvasWindingRule
The isPointInPath()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, Path2d
pub fn is_point_in_path_with_path_2d_and_f64_and_winding(
&self,
path: &Path2d,
x: f64,
y: f64,
winding: CanvasWindingRule
) -> bool
pub fn is_point_in_path_with_path_2d_and_f64_and_winding(
&self,
path: &Path2d,
x: f64,
y: f64,
winding: CanvasWindingRule
) -> bool
The isPointInPath()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, CanvasWindingRule
, Path2d
The isPointInStroke()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The isPointInStroke()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, Path2d
The stroke()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The stroke()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, Path2d
The createLinearGradient()
method.
This API requires the following crate features to be activated: CanvasGradient
, CanvasRenderingContext2d
pub fn create_pattern_with_html_image_element(
&self,
image: &HtmlImageElement,
repetition: &str
) -> Result<Option<CanvasPattern>, JsValue>
pub fn create_pattern_with_html_image_element(
&self,
image: &HtmlImageElement,
repetition: &str
) -> Result<Option<CanvasPattern>, JsValue>
The createPattern()
method.
This API requires the following crate features to be activated: CanvasPattern
, CanvasRenderingContext2d
, HtmlImageElement
pub fn create_pattern_with_svg_image_element(
&self,
image: &SvgImageElement,
repetition: &str
) -> Result<Option<CanvasPattern>, JsValue>
pub fn create_pattern_with_svg_image_element(
&self,
image: &SvgImageElement,
repetition: &str
) -> Result<Option<CanvasPattern>, JsValue>
The createPattern()
method.
This API requires the following crate features to be activated: CanvasPattern
, CanvasRenderingContext2d
, SvgImageElement
pub fn create_pattern_with_html_canvas_element(
&self,
image: &HtmlCanvasElement,
repetition: &str
) -> Result<Option<CanvasPattern>, JsValue>
pub fn create_pattern_with_html_canvas_element(
&self,
image: &HtmlCanvasElement,
repetition: &str
) -> Result<Option<CanvasPattern>, JsValue>
The createPattern()
method.
This API requires the following crate features to be activated: CanvasPattern
, CanvasRenderingContext2d
, HtmlCanvasElement
pub fn create_pattern_with_html_video_element(
&self,
image: &HtmlVideoElement,
repetition: &str
) -> Result<Option<CanvasPattern>, JsValue>
pub fn create_pattern_with_html_video_element(
&self,
image: &HtmlVideoElement,
repetition: &str
) -> Result<Option<CanvasPattern>, JsValue>
The createPattern()
method.
This API requires the following crate features to be activated: CanvasPattern
, CanvasRenderingContext2d
, HtmlVideoElement
pub fn create_pattern_with_image_bitmap(
&self,
image: &ImageBitmap,
repetition: &str
) -> Result<Option<CanvasPattern>, JsValue>
pub fn create_pattern_with_image_bitmap(
&self,
image: &ImageBitmap,
repetition: &str
) -> Result<Option<CanvasPattern>, JsValue>
The createPattern()
method.
This API requires the following crate features to be activated: CanvasPattern
, CanvasRenderingContext2d
, ImageBitmap
The createRadialGradient()
method.
This API requires the following crate features to be activated: CanvasGradient
, CanvasRenderingContext2d
The addHitRegion()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The addHitRegion()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, HitRegionOptions
The clearHitRegions()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The removeHitRegion()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The createImageData()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, ImageData
The createImageData()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, ImageData
The getImageData()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, ImageData
The putImageData()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, ImageData
The putImageData()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, ImageData
The getLineDash()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The setLineDash()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The bezierCurveTo()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The closePath()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The ellipse()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The lineTo()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The moveTo()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The quadraticCurveTo()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The clearRect()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The strokeRect()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The restore()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The save()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The fillText()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The measureText()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, TextMetrics
The strokeText()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The strokeText()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The getTransform()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, DomMatrix
The resetTransform()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The drawCustomFocusRing()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, Element
The drawFocusIfNeeded()
method.
This API requires the following crate features to be activated: CanvasRenderingContext2d
, Element
The CanvasRenderingContext2D.DRAWWINDOW_DRAW_CARET
const.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The CanvasRenderingContext2D.DRAWWINDOW_DO_NOT_FLUSH
const.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The CanvasRenderingContext2D.DRAWWINDOW_DRAW_VIEW
const.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The CanvasRenderingContext2D.DRAWWINDOW_USE_WIDGET_LAYERS
const.
This API requires the following crate features to be activated: CanvasRenderingContext2d
The CanvasRenderingContext2D.DRAWWINDOW_ASYNC_DECODE_IMAGES
const.
This API requires the following crate features to be activated: CanvasRenderingContext2d
Methods from Deref<Target = Object>
The constructor property returns a reference to the Object
constructor
function that created the instance object.
The hasOwnProperty()
method returns a boolean indicating whether the
object has the specified property as its own property (as opposed to
inheriting it).
The isPrototypeOf()
method checks if an object exists in another
object’s prototype chain.
The propertyIsEnumerable()
method returns a Boolean indicating
whether the specified property is enumerable.
The toLocaleString()
method returns a string representing the object.
This method is meant to be overridden by derived objects for
locale-specific purposes.
The toString()
method returns a string representing the object.
The valueOf()
method returns the primitive value of the
specified object.
Methods from Deref<Target = JsValue>
Returns the f64
value of this JS value if it’s an instance of a
number.
If this JS value is not an instance of a number then this returns
None
.
If this JS value is a string value, this function copies the JS string
value into wasm linear memory, encoded as UTF-8, and returns it as a
Rust String
.
To avoid the copying and re-encoding, consider the
JsString::try_from()
function from js-sys
instead.
If this JS value is not an instance of a string or if it’s not valid
utf-8 then this returns None
.
UTF-16 vs UTF-8
JavaScript strings in general are encoded as UTF-16, but Rust strings
are encoded as UTF-8. This can cause the Rust string to look a bit
different than the JS string sometimes. For more details see the
documentation about the str
type which contains a few
caveats about the encodings.
Returns the bool
value of this JS value if it’s an instance of a
boolean.
If this JS value is not an instance of a boolean then this returns
None
.
Tests whether this JS value is undefined
Tests whether the type of this JS value is function
.
Applies the unary typeof
JS operator on a JsValue
.
Applies the binary in
JS operator on the two JsValue
s.
Compare two JsValue
s for equality, using the ==
operator in JS.
Applies the unary ~
JS operator on a JsValue
.
Applies the binary >>>
JS operator on the two JsValue
s.
Applies the binary /
JS operator on two JsValue
s, catching and returning any RangeError
thrown.
Applies the binary **
JS operator on the two JsValue
s.
Applies the binary <
JS operator on the two JsValue
s.
Applies the binary <=
JS operator on the two JsValue
s.
Applies the binary >=
JS operator on the two JsValue
s.
Applies the binary >
JS operator on the two JsValue
s.
Applies the unary +
JS operator on a JsValue
. Can throw.
Trait Implementations
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs a dynamic instanceof
check to see whether the JsValue
provided is an instance of this type. Read more
Performs a zero-cost unchecked conversion from a JsValue
into an
instance of Self
Read more
Performs a zero-cost unchecked conversion from a &JsValue
into an
instance of &Self
. Read more
Test whether this JS value has a type T
. Read more
Performs a dynamic cast (checked at runtime) of this value into the
target type T
. Read more
Performs a dynamic cast (checked at runtime) of this value into the
target type T
. Read more
Performs a zero-cost unchecked cast into the specified type. Read more
Performs a zero-cost unchecked cast into a reference to the specified type. Read more
Test whether this JS value is an instance of the type T
. Read more
Performs a dynamic check to see whether the JsValue
provided
is a value of this type. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
The wasm ABI type references to Self
are recovered from.
The type that holds the reference to Self
for the duration of the
invocation of the function that has an &Self
parameter. This is
required to ensure that the lifetimes don’t persist beyond one function
call, and so that they remain anonymous. Read more
Recover a Self::Anchor
from Self::Abi
. Read more
Auto Trait Implementations
impl RefUnwindSafe for CanvasRenderingContext2d
impl !Send for CanvasRenderingContext2d
impl !Sync for CanvasRenderingContext2d
impl Unpin for CanvasRenderingContext2d
impl UnwindSafe for CanvasRenderingContext2d
Blanket Implementations
Mutably borrows from an owned value. Read more
type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
Same as IntoWasmAbi::Abi
Same as IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
. Read more