LibreOffice
LibreOffice 6.4 SDK API Reference
Public Types | Public Attributes | List of all members
RenderState Struct Reference

This structure contains information passed to each XCanvas render operation. More...

import"RenderState.idl";

Public Types

typedef sequence< ColorComponentDeviceColor
 The device color associated with this render operation. More...
 

Public Attributes

::com::sun::star::geometry::AffineMatrix2D AffineTransform
 The affine transform associated with this render operation. More...
 
XPolyPolygon2D Clip
 The clipping area associated with this render operation. More...
 
byte CompositeOperation
 The composition mode associated with this render operation. More...
 

Detailed Description

This structure contains information passed to each XCanvas render operation.

This structure contains information considered as the render state, i.e. the common setup required to render each individual XCanvas primitive.

Since
OOo 2.0

Member Typedef Documentation

◆ DeviceColor

The device color associated with this render operation.

Note that this need not be RGB here, but depends on the active device color space.

See also
XGraphicDevice
XColorSpace

Member Data Documentation

◆ AffineTransform

The affine transform associated with this render operation.

This is used to transform coordinates of canvas primitives from user space to view space (from which they are subsequently transformed to device space by the view transform).

◆ Clip

The clipping area associated with this render operation.

This clipping is interpreted in the user coordinate system, i.e. subject to the render state transform followed by the view transform before mapped to device coordinate space.

Specifying an empty interface denotes no clipping, i.e. everything rendered to the canvas will be visible (subject to device-dependent constraints, of course). Specifying an empty XPolyPolygon2D, i.e. a poly-polygon containing zero polygons, or an XPolyPolygon2D with any number of empty sub-polygons, denotes the NULL clip. That means, nothing rendered to the canvas will be visible.

◆ CompositeOperation

byte CompositeOperation

The composition mode associated with this render operation.

The composite mode determines in which way the primitive and possibly existing background is combined. The permissible values must be one out of the CompositeOperation constants.


The documentation for this struct was generated from the following file: