Skip to main content

RenderingContext:draw_bitmap()

RenderingContext:draw_bitmap(param_table)
RenderingContext:draw_bitmap(bitmap[, x, y[, width, height[, angle[, scale]]])

This method draws a bitmap.

Parameters

ParameterTypeDescription
param_tabletableThis parameter is in associative array table format, meaning it's specified by keys rather than parameter positions. See the Parameters Table section.
bitmapBitmapThe bitmap for drawing.
xnumberDraw the bitmap's origin to coincide with this parameter's position in the target space.
The default is 0.
ynumberDraw the bitmap's origin to coincide with this parameter's position in the target space.
The default is 0.
widthnumberPerform horizontal scaling to match the bitmap's width to the specified value in the target space.The default is the bitmap's width.
heightnumberPerform vertical scaling to match the bitmap's height to the specified value in the target space.The default is the bitmap's height.
anglenumberRotate counterclockwise by the specified angle in degrees around the bitmap's origin.The default is 0.
scalenumberThe scaling factor.
If width and height are specified together, the final scaling factor becomes the cumulative value.

Parameters Table

KeyTypeDescription
bitmapBitmapThe bitmap for drawing.
xnumberDraw the bitmap's origin to coincide with this parameter's position in the target space.
The default is 0.
ynumberDraw the bitmap's origin to coincide with this parameter's position in the target space.
The default is 0.
widthnumberPerform horizontal scaling to match the bitmap's width to the specified value in the target space.The default is the bitmap's width.
heightnumberPerform vertical scaling to match the bitmap's height to the specified value in the target space.The default is the bitmap's height.
anglenumberRotate counterclockwise by the specified angle in degrees around the bitmap's origin.The default is 0.
scalenumberThe scaling factor.
If width and height are specified together, the final scaling factor becomes the cumulative value.

Return Values

This method doesn't return any value.

See Also