Class TCustomCanvas

Currently set rendering mode in relation to premultiplied or non-premultiplied alpha.

Currently defined texture for rendering.

Currently defined coordinates within the texture set in FCurrentTexture.

Creates new instance of canvas bound to the specific device.

Prepares the canvas to start the rendering. Any rendering calls can be made after this method succeeds. Returns True when successful and False otherwise.

Initializes the canvas so it can be used for rendering. Note that for actual rendering to take place, BeginScene needs to be called first, assuming that initialization succeeded. This results True when successful and False otherwise.

Sets custom shader effect to be used for rendering. This functionality may be provider and platform dependent. Also, for this to work, TCanvasAttribute.CustomEffect should be set in Attributes.

Sets the palette to be used for rendering 8-bit indexed images. Support for such images varies depending on provider and platform. This returns True when successful and False otherwise.

Prepares the canvas for rendering, after which any number of rendering calls can be made. Returns True when successful and False otherwise.

Restores the canvas after its resources have been lost (that is, after DeviceRelease call). This may be implemented by derived classes to handle "device lost" scenario.

Returns the currently set clipping rectangle.

Creates any implementation specific resources for rendering, including hardware and/or GPU resources. Returns True when successful and False otherwise.

Depending on actual implementation, this indicates whether the canvas requires initialization or not. When this method returns False, then the canvas becomes initialized at the creation and cannot be "finalized".

Draws circle with given origin, radius and color. This function uses Line primitive. Steps parameter indicates number of divisions in the ellipse. UseWuLines determines whether to use WuLine primitive instead.

Draws one or more triangles filled with color gradient, specified by vertex, color and index buffers. This method is considered basic functionality and should always be implemented by derived classes.

Draws one or more triangles filled with texture and color gradient, specified by vertex, texture coordinates, color and index buffers.This method is considered basic functionality and should always be implemented by derived classes.

Draws ellipse with given origin, radiuses and color. This function uses Line primitive. Steps parameter indicates number of divisions in the ellipse. UseWuLines indicates whether to use WuLine primitive instead.

Finishes rendering phase in the canvas.

Draws filled arc at the given coordinates and radius. The arc begins at InitAngle and ends at EndAngle (in radians), subdivided into a number of triangles specified in Steps. The arc's shape is filled with four color gradient.

Draws filled arc at the given position and radius. The arc begins at InitAngle and ends at EndAngle (in radians), subdivided into a number of triangles specified in Steps. The arc's shape is filled with four color gradient.

Draws filled circle at the given position and radius. The circle is subdivided into a number of triangles specified in Steps. The shape of circle is filled with four color gradient.

Draws filled ellipse at the given position and radius. The ellipse is subdivided into a number of triangles specified in Steps. The shape of ellipse is filled with four color gradient.

Draws hexagon where vertices are spaced 0.5 pixels apart from its center (so diameter is 1) in all directions, multiplied by the given matrix and filled with gradient of six colors at the corresponding vertices. The size, position and rotation of hexagon can be given using one or a combination of several 3x3 matrices multiplied together.

Draws quadrilateral with color gradient specified by given vertices and colors.

Draws rectangle filled with single color and specified by given coordinates, and colors.

Draws rectangle filled with single color and specified by given margins, and colors.

Draws rectangle with color gradient specified by given margins and colors.

Draws filled ribbon at the given position between inner and outer radiuses. The ribbon begins at InitAngle and ends at EndAngle (in radians), subdivided into a number of triangles specified in Steps. The ribbon's shape is filled with four color gradient.

Draws filled ribbon at the given position between inner and outer radiuses. The ribbon begins at InitAngle and ends at EndAngle (in radians), subdivided into a number of triangles specified in Steps. The ribbon's shape is filled with continuous gradient set by three pairs of inner and outer colors.

Draws triangle filled with color gradient specified by given positions and colors.

Finalizes the canvas and releases any resources that were previously allocated during initialization.

Flushes the canvas cache and presents the pending primitives on the destination surface. This can be useful to make sure that nothing remains in canvas cache before starting to render, for instance, a 3D scene.

Draws rectangle with line width of one pixel specified by given vertices and colors. Although this may receive coordinates for shapes other than rectangle (for example, quadrilateral), the result may be unpredictable. This method unlike other line drawing methods uses filled shapes and assumes that four vertices are aligned to form rectangle. The produced result respects last pixel rule and can be used for drawing UI elements (whereas methods like WireQuad may produce incorrectly sized rectangles depending on implementation).

Draws rectangle with line width of one pixel specified by given margins and colors. This works in similar fashion as other overloaded FrameRect method by drawing filled shapes instead of lines, and is meant for rendering UI elements.

Draws horizontal line with specified coordinates and color gradient. This method uses filled shapes instead of actual lines to produce accurate results and is meant for rendering UI elements.

Draws horizontal line with specified coordinates and single color. This method uses filled shapes instead of actual lines to produce accurate results and is meant for rendering UI elements.

Draws line between two specified positions and filled with color gradient. This method is considered basic functionality and should always be implemented by derived classes.

Draws line between two specified positions and filled with single color.

Draws line between specified coordinate pairs and filled with single color.

Draws line between specified coordinate pairs and filled with color gradient.

Draws series of lines between specified vertices using solid color.

Draws a single pixel on the destination surface with the specified position and color (alpha-blended). This method is considered basic functionality and should always be implemented by derived classes.

Draws a single pixel on the destination surface with the specified coordinates and color (alpha-blended).

Draws a filled rectangle at the given position and size with a hole (in form of ellipse) inside at the given center and radius. The quality of the hole is defined by the value of Steps in number of subdivisions. This entire shape is filled with gradient starting from outer color at the edges of rectangle and inner color ending at the edge of hole. This shape can be particularly useful for highlighting items on the screen by darkening the entire area except the one inside the hole.

Resets all the states necessary for canvas operation. This can be useful when custom state changes have been made (for instance, in a 3D scene) so to restore the canvas to its working condition this method should be called.

Resets the palette to be used for rendering 8-bit indexed images that was previously set by SetPalette.

Draws textured rectangle at given vertices and multiplied by the specified four color gradient. The texture must be set prior to this call by one of UseTexture[...] or UseImage[...] calls. For every call of TexQuad there must be a preceding UseTexture[...] or UseImage[...] call to specify the image or texture. All pixels of the rendered texture are multiplied by the gradient color before applying alpha-blending. If the texture has no alpha-channel present, alpha value of the gradient will be used instead.

Defines the specified image with one of its textures to be used in next call to TexQuad. The coordinates inside the texture are defined in logical units in range of [0..1].

Defines the specified image to be used in next call to TexQuad. If the image has multiple textures, then the first one will be used.

Defines the specified image with one of its textures to be used in next call to TexQuad. The coordinates inside the texture are defined in pixels using floating-point coordinates.

Defines the specified region of the image to be used in next call to TexQuad. That region can also be mirrored horizontally and/or flipped vertically, if needed. If the image has no or just one pattern, the value of Region should be set to zero; in this case, the entire texture is used instead.

Defines the specified region of the image to be used in next call to TexQuad. Only a certain portion of that region is used for rendering defined by the given coordinates; these coordinates can also be mirrored horizontally and/or flipped vertically, if needed. If the image has no or just one pattern, the value of Region should be set to zero; in this case, the entire texture is used instead.

Defines the specified region of the image to be used in next call to TexQuad. If the image has none or just one region defined, the value of Region should be set to zero; in this case, the entire texture is used instead.

Defines the specified texture to be used in next call to TexQuad. The coordinates inside the texture are defined in logical units in range of [0..1].

Defines the specified texture to be used in next call to TexQuad. The coordinates inside the texture are defined in pixels using floating-point coordinates.

Draws vertical line with specified coordinates and single color. This method uses filled shapes instead of actual lines to produce accurate results and is meant for rendering UI elements.

Draws vertical line with specified coordinates and color gradient. This method uses filled shapes instead of actual lines to produce accurate results and is meant for rendering UI elements.

Draws lines between each vertex in hexagon. The vertices are spaced 0.5 pixels apart from its center (so diameter is 1) in all directions, multiplied by the given matrix and filled with gradient of six colors at the corresponding vertices. The size, position and rotation of hexagon can be given using one or a combination of several 3x3 matrices multiplied together. This method uses Line primitive. UseWuLines determines whether to use WuLine primitive instead.

Draws lines between the specified vertices (making it a wireframe quadrilateral) and vertex colors. Note that this may not necessarily respect last pixel rendering rule). This method uses Line primitive. UseWuLines determines whether to use WuLine primitive instead.

Draws antialiased "wu-line" using PutPixel primitive between specified positions filled with single color.

Releases the resources of canvas when the device has been lost. This may be implemented by derived classes to handle "device lost" scenario.

Releases any implementation specific resources for rendering, including hardware and/or GPU resources.

Finishes rendering and depending on implementation may present results on destination surface.

This method can be called by specific implementations to indicate that canvas buffer is full and new rendering stage begins. Basically, this increments CacheStall by one, which by default is reset back to zero after call to BeginScene.

Specifies new clipping rectangle for rendering.

Makes the necessary arrangements so that newly set canvas attributes are taken into account for next rendering calls.

Defines one or more canvas attributes that affect the rendering behavior.

Number of times that rendering cache was reset during last rendering frame. Each cache reset is typically a time-consuming operation so high number of such events could be detrimental to the application's rendering performance. If this parameter happens to be considerably high in the rendered scene, the rendering code should be revised for better grouping of images, shapes and blending types.

The clipping rectangle in which the rendering will be made. This can be useful for restricting the rendering to a certain portion of surface.

The device to which this canvas is bound to.

Indicates whether the canvas has been initialized by using Initialize function.

Provides access to canvas parent if there is such.