com.livecode.canvas

Typemodule
DictionaryLCB
LibraryLiveCode Builder
Associationscom.livecode.canvas
Summary

This module specifies the syntax definitions and bindings for canvas drawing operations in modular LiveCode.

Description

This module specifies the syntax definitions and bindings for canvas drawing operations in modular LiveCode.

TypeNameSummarySyntax
expressionEffectMake

Creates a new effect.

<mType> effect

- - -FontMakeWithStyle

Creates a new instance of the named font.

font <mName> with ( bold | italic | bold italic ) style

- - -PathMakeEmpty

Creates a new empty path.

the empty path

- - -ThisCanvas

The canvas used when drawing a widget.

this canvas

- - -TransformMakeIdentity

The identity transform.

the identity transform

modulecom.livecode.canvas

This module specifies the syntax definitions and bindings for canvas drawing operations in modular LiveCode.

the identity transform

operatorCanvasPropertyAntialias

The current antialias setting of a canvas.

the antialias of <mCanvas>

- - -CanvasPropertyBlendMode

The current blend mode of a canvas.

the blend mode of <mCanvas>

- - -CanvasPropertyCapStyle

The current cap style of a canvas.

the cap style of <mCanvas>

- - -CanvasPropertyClippingBounds

The current clipping bounds of the canvas.

the clipping bounds of <mCanvas>

- - -CanvasPropertyDashes

The current dashes of a canvas.

the dashes of <mCanvas>

- - -CanvasPropertyDashPhase

The current dash phase of a canvas.

the dash phase of <mCanvas>

- - -CanvasPropertyDeviceTransform

The current device transform of the canvas.

the device transform of <mCanvas>

- - -CanvasPropertyFillRule

The current fill rule of a canvas.

the fill rule of <mCanvas>

- - -CanvasPropertyFont

The current font of a canvas.

the font of <mCanvas>

- - -CanvasPropertyImageResizeQuality

The current image resize quality of a canvas.

the image resize quality of <mCanvas>

- - -CanvasPropertyJoinStyle

The current join style of a canvas.

the join style of <mCanvas>

- - -CanvasPropertyMiterLimit

The current miter limit of a canvas.

the miter limit of <mCanvas>

- - -CanvasPropertyOpacity

The current opacity setting of a canvas.

the opacity of <mCanvas>

- - -CanvasPropertyPaint

The current paint of a canvas.

the paint of <mCanvas>

- - -CanvasPropertyStippled

The current stippled setting of a canvas.

the stippled of <mCanvas>

- - -CanvasPropertyStrokeWidth

The current stroke width of a canvas.

the stroke width of <mCanvas>

- - -ColorMake

Creates a new color value.

color <mColor>

- - -ColorPropertyAlpha

The alpha component of a color value.

the alpha of <mColor>

- - -ColorPropertyBlue

The blue component of a color value.

the blue of <mColor>

- - -ColorPropertyGreen

The green component of a color value.

the green of <mColor>

- - -ColorPropertyRed

The red component of a color value.

the red of <mColor>

- - -EffectMakeWithProperties

Creates a new effect.

<mType> effect with properties <mProperties>

- - -EffectPropertyAngle

The angle of an effect.

the angle of <mEffect>

- - -EffectPropertyBlendMode

The blend mode of an effect.

the blend mode of <mEffect>

- - -EffectPropertyColor

The color of an effect.

the color of <mEffect>

- - -EffectPropertyDistance

The distance of an effect.

the distance of <mEffect>

- - -EffectPropertyKnockOut

The knockout of an effect.

the knockout of <mEffect>

- - -EffectPropertySize

The size of an effect.

the size of <mEffect>

- - -EffectPropertySource

The source of an effect.

the source of <mEffect>

- - -EffectPropertySpread

The spread of an effect.

the spread of <mEffect>

- - -EffectPropertyType

The type of an effect.

the type of <mEffect>

- - -FontMake

Creates a new instance of the named font.

font <mName>

- - -FontMakeWithSize

Creates a new instance of the named font.

font <mName> at size <mSize>

- - -FontMakeWithStyleAndSize

Creates a new instance of the named font.

font <mName> with ( bold | italic | bold italic ) style at size <mSize>

- - -FontOperationTextImageBounds

Measure text precisely when drawn with a font.

the image bounds of text <mText> with <mFont>

- - -FontOperationTextImageBoundsOnCanvas

Measure text precisely when drawn to a canvas.

the image bounds of text <mText> on <mCanvas>

- - -FontOperationTextLayoutBounds

Measure text when drawn with a font.

the [ layout ] bounds of text <mText> with <mFont>

- - -FontOperationTextLayoutBoundsOnCanvas

Measure text when drawn to a canvas.

the [ layout ] bounds of text <mText> on <mCanvas>

- - -FontPropertyBold

The bold setting of a font.

the bold of <mFont>

- - -FontPropertyItalic

The italic setting of a font.

the italic of <mFont>

- - -FontPropertyName

The name of a font.

the name of <mFont>

- - -FontPropertySize

The size of a font.

the size of <mFont>

- - -GetPixelDataOfCanvas

Get the current contents of a canvas as raw pixel data

the pixel data of <Canvas>

- - -GetPixelHeightOfCanvas

Get the height of a canvas in pixels.

the pixel height of <Canvas>

- - -GetPixelWidthOfCanvas

Get the width of a canvas in pixels.

the pixel width of <Canvas>

- - -GradientMakeWithRamp

Creates a new gradient paint.

<mType> gradient with ramp <mRamp>

- - -GradientPropertyFrom

The from point of a gradient paint.

the from of <mGradient>

- - -GradientPropertyMirror

The mirror of a gradient paint.

the mirror of <mGradient>

- - -GradientPropertyRamp

The ramp of a gradient paint.

the ramp of <mGradient>

- - -GradientPropertyRepeat

The repeat count of a gradient paint.

the repeat of <mGradient>

- - -GradientPropertyTo

The to point of a gradient paint.

the to of <mGradient>

- - -GradientPropertyTransform

The transform of a gradient paint.

the transform of <mGradient>

- - -GradientPropertyType

The type of a gradient paint.

the type of <mGradient>

- - -GradientPropertyVia

The via point of a gradient paint.

the via of <mGradient>

- - -GradientPropertyWrap

The wrap of a gradient paint.

the wrap of <mGradient>

- - -GradientStopMake

Creates a new gradient stop.

gradient stop at <mOffset> with <mColor>

- - -GradientStopPropertyColor

The color of a gradient stop value.

the color of <mStop>

- - -GradientStopPropertyOffset

The offset of a gradient stop value.

the offset of <mStop>

- - -ImageDensityProperty

The density of an image.

the density of <mImage>

- - -ImageIsValid

The validity of an image

<mImage> is valid

- - -ImageMakeFromData

Creates a new image.

image from data <mData>

- - -ImageMakeFromFile

Creates a new image.

image from file <mPath>

- - -ImageMakeFromResourceFile

Creates a new image.

image from resource file <mResource>

- - -ImageMakeWithPixels

Creates a new image using raw pixel data.

image of size <mSize> with pixels <mPixels>

- - -ImageMetadataProperty

the metadata associated with an image.

the metadata of <mImage>

- - -ImagePropertyHeight

The height of an image.

the height of <mImage>

- - -ImagePropertyPixels

The pixel data of an image.

the pixels of <mImage>

- - -ImagePropertyWidth

The width of an image.

the width of <mImage>

- - -NewCanvasWithSize

Create a new canvas

a new canvas with size <Size>

- - -PathMake

Creates a new path.

path <mInstructions>

- - -PathMakeWithArc

Creates a new path.

arc path centered at <mCenter> with [ radius <mRadius> | radii <mRadii> ] from <mStartAngle> to <mEndAngle>

- - -PathMakeWithCircle

Creates a new path.

circle path centered at <mCenter> with radius <mRadius>

- - -PathMakeWithEllipse

Creates a new path. mCenter:An expression which evaluates to a point.

ellipse path centered at <mPoint> with radii <mRadii>

- - -PathMakeWithLine

Creates a new path.

line path from <mFrom> to <mTo>

- - -PathMakeWithPoints

Creates a new path.

( polygon | polyline ) path with points <mPoints>

- - -PathMakeWithRectangle

Creates a new path.

rectangle path of <mRect>

- - -PathMakeWithRoundedRectangleWithRadii

Create a new rectangle path with elliptical corner rounding

rounded rectangle path of <Rectangle> with radii <Radii>

- - -PathMakeWithRoundedRectangleWithRadius

Creates a new path. mRadii:An expression which evaluates to a list of numbers.

rounded rectangle path of <mRect> with radius <mRadius>

- - -PathMakeWithSector

Creates a new path.

sector path centered at <mCenter> with [ radius <mRadius> | radii <mRadii> ] from <mStartAngle> to <mEndAngle>

- - -PathMakeWithSegment

Creates a new path.

segment path centered at <mCenter> with [ radius <mRadius> | radii <mRadii> ] from <mStartAngle> to <mEndAngle>

- - -PathPropertyBoundingBox

The bounding box of a path.

the bounding box of <mPath>

- - -PathPropertyInstructions

The instructions of a path.

the instructions of <mPath>

- - -PathPropertySubpath

The subpaths of a path.

subpath <mStart> [ to <mEnd> ] of <mPath>

- - -PatternMake

Creates a new pattern paint.

pattern with <mImage>

- - -PatternMakeRotatedBy

Creates a new rotated pattern paint.

pattern with <mImage> rotated by <mRotation>

- - -PatternMakeScaledBy

Creates a new scaled pattern paint.

pattern with <mImage> scaled by <mScale>

- - -PatternMakeTransformed

Creates a new transformed pattern paint.

pattern with <mImage> transformed by <mTransform>

- - -PatternMakeTranslatedBy

Creates a new translated pattern paint.

pattern with <mImage> translated by <mTranslation>

- - -PatternPropertyImage

The image of a pattern value.

the image of <mPattern>

- - -PatternPropertyTransform

The transform of a pattern value.

the transform of <mPattern>

- - -PointMake

Creates a new point value.

point <mPoint>

- - -PointPropertyX

The x coordinate of a point value.

the x of <mPoint>

- - -PointPropertyY

The y coordinate of a point value.

the y of <mPoint>

- - -RectangleMake

Creates a new rectangle value.

rectangle <mRect>

- - -RectanglePropertyBottom

The bottom edge of a rectangle value.

the bottom of <mRect>

- - -RectanglePropertyHeight

The height of a rectangle value.

the height of <mRect>

- - -RectanglePropertyLeft

The left edge of a rectangle value.

the left of <mRect>

- - -RectanglePropertyRight

The right edge of a rectangle value.

the right of <mRect>

- - -RectanglePropertyTop

The top edge of a rectangle value.

the top of <mRect>

- - -RectanglePropertyWidth

The width of a rectangle value.

the width of <mRect>

- - -SolidPaintMake

Creates a new solid color paint.

solid paint with <mColor>

- - -SolidPaintPropertyColor

The color of a solid paint value. mPaint:An expression which evaluates to a solid paint.

the color of <mSolid>

- - -TransformMakeRotation

Creates a new rotation transform value.

transform with rotation by <mRotation>

- - -TransformMakeScale

Creates a new scaling transform value.

transform with scale <mScale>

- - -TransformMakeSkew

Creates a new skewing transform value. mScale:An expression which evaluates to a list of 2 numbers, the x-axis skew and y-axis skew.

transform with skew <mSkew>

- - -TransformMakeTranslation

Creates a new translation transform.

transform with translation <mTranslation>

- - -TransformMakeWithMatrixAsList

Creates a new transform. mTranslation:An expression which evaluates to a list of 6 numbers, the a, b, c, d, tx and ty values of the transform matrix.

transform with matrix <mMatrix>

- - -TransformOperationMultiply

Multiply two transforms together.

<Left> * <Right>

- - -TransformPropertyInverse

The inverse of a transform.

the inverse of <mTransform>

- - -TransformPropertyMatrixAsList

The matrix values of a transform.

the matrix of <mTransform>

- - -TransformPropertyRotation

The rotation component of a transform.

the rotation of <mTransform>

- - -TransformPropertyScale

The scale component of a transform.

the scale of <mTransform>

- - -TransformPropertySkew

The skew component of a transform.

the skew of <mTransform>

- - -TransformPropertyTranslation

The translation component of a transform.

the translation of <mTransform>

statementCanvasOperationAddPath

Add a path to a canvas.

add <mPath> to <mCanvas>

- - -CanvasOperationBeginLayer

Begin a new drawing layer on a canvas. mBounds:An expression which evaluates to a rectangle.

begin layer [ with <mEffect> ] on <mCanvas>

- - -CanvasOperationClip

Clip to a rectangle on a canvas.

clip to <mRect> on <mCanvas>

- - -CanvasOperationClipPath

Clip to a path on a canvas.

clip to <mPath> on <mCanvas>

- - -CanvasOperationClosePath

Closes the current subpath of a canvas.

close path on <mCanvas>

- - -CanvasOperationCurveThrough

Add a curve to a canvas.

curve through <mThroughA> [ then <mThroughB> ] to <mPoint> on <mCanvas>

- - -CanvasOperationDrawImage

Draw an image on a canvas.

draw [ from <mSrcRect> of ] <mImage> into <mDestRect> of <mCanvas>

- - -CanvasOperationEndLayer

End the current drawing layer on a canvas.

end layer on <mCanvas>

- - -CanvasOperationFill

Fill a path on a canvas.

fill [ <mPath> on ] <mCanvas>

- - -CanvasOperationFillText

Render filled text on a canvas.

fill text <mText> at <mPoint> on <mCanvas>

- - -CanvasOperationFillTextAligned

Render filled text on a canvas.

fill text <mText> at <mAlignment> of <mRect> on <mCanvas>

- - -CanvasOperationLineTo

Add a line to a canvas.

line to <mPoint> on <mCanvas>

- - -CanvasOperationMeasureText

Measure text when drawn to a canvas.

measure <mText> on <mCanvas>

- - -CanvasOperationMoveTo

Move to a point on a canvas.

move to <mPoint> on <mCanvas>

- - -CanvasOperationRestoreState

Restore the previously saved state of a canvas.

restore state of <mCanvas>

- - -CanvasOperationRotate

Apply a rotation to a canvas.

rotate <mCanvas> by <mRotation>

- - -CanvasOperationSaveState

Save the current state of a canvas.

save state of <mCanvas>

- - -CanvasOperationScale

Apply a scale to a canvas.

scale <mCanvas> by <mScale>

- - -CanvasOperationStroke

Stroke a path on a canvas.

stroke [ <mPath> on ] <mCanvas>

- - -CanvasOperationTransform

Apply a transform to a canvas.

transform <mCanvas> by <mTransform>

- - -CanvasOperationTranslate

Apply a translation to a canvas.

translate <mCanvas> by <mTranslation>

- - -GradientOperationAddStop

Add a new stop to the ramp of a gradient paint.

add <mStop> to <mGradient>

- - -GradientOperationRotate

Apply a rotation to a gradient paint.

rotate <mGradient> by <mRotation>

- - -GradientOperationScale

Apply a scale to a gradient paint.

scale <mGradient> by <mScale>

- - -GradientOperationTransform

Apply a transform to a gradient paint.

transform <mGradient> by <mTransform>

- - -GradientOperationTranslate

Apply a translation to a gradient paint.

translate <mGradient> by <mTranslation>

- - -PathOperationAddPath

Extend a path by adding another path.

add <mSource> to <mDest>

- - -PathOperationArcTo

Adds an arc to a path.

arc through <mThrough> to <mTo> with radius <mRadius> on <mPath>

- - -PathOperationClosePath

Closes the current subpath of a path.

close path on <mPath>

- - -PathOperationCurveThrough

Adds a curve to a path.

curve through <mThroughA> [ then <mThroughB> ] to <mTo> on <mPath>

- - -PathOperationEllipticArcTo

Adds an arc to a path.

arc to <mEnd> with radii <mRadii> rotated by <mAngle> on <mPath>

- - -PathOperationEllipticArcToWithFlags

Adds an arc to a path.

arc to <mEnd> with radii <mRadii> rotated by <mAngle> taking ( largest | smallest ) ( clockwise | anticlockwise ) route on <mPath>

- - -PathOperationLineTo

Adds a line to a path.

line to <mPoint> on <mPath>

- - -PathOperationMoveTo

Move to a new point on a path.

move to <mPoint> on <mPath>

- - -PathOperationRotate

Apply a rotation to a path.

rotate <mPath> by <mRotation>

- - -PathOperationScale

Apply a scale to a path.

scale <mPath> by <mScale>

- - -PathOperationTransform

Apply a transform to a path.

transform <mPath> by <mTransform>

- - -PathOperationTranslate

Apply a translation to a path.

translate <mPath> by <mTranslation>

- - -PatternOperationRotate

Apply a rotation to a pattern.

rotate <mPattern> by <mRotation>

- - -PatternOperationScale

Apply a scale to a pattern.

scale <mPattern> by <mScale>

- - -PatternOperationTransform

Apply a transform to a pattern.

transform <mPattern> by <mTransform>

- - -PatternOperationTranslate

Apply a translation to a pattern.

translate <mPattern> by <mTranslation>

- - -TransformOperationConcat

Concatenate transform a with transform b.

concat <mTransformA> with <mTransformB>

- - -TransformOperationRotate

Apply a rotation to a transform.

rotate <mTransform> by <mRotation>

- - -TransformOperationScale

Apply a scale to a transform.

scale <mTransform> by <mScale>

- - -TransformOperationSkew

Apply a skew to a transform.

skew <mTransform> by <mSkew>

- - -TransformOperationTranslate

Apply a translation to a transform.

translate <mTransform> by <mTranslation>