Struct qt_gui::paint_engine_state::PaintEngineState

#[repr(C)]
pub struct PaintEngineState(_);

C++ type: QPaintEngineState

C++ documentation:

The QPaintEngineState class provides information about the active paint engine’s current state.

QPaintEngineState records which properties that have changed since the last time the paint engine was updated, as well as their current value.

Which properties that have changed can at any time be retrieved using the state() function. This function returns an instance of the QPaintEngine::DirtyFlags type which stores an OR combination of QPaintEngine::DirtyFlag values. The QPaintEngine::DirtyFlag enum defines whether a property has changed since the last update or not.

If a property is marked with a dirty flag, its current value can be retrieved using the corresponding get function:

Property Flag	Current Property Value
QPaintEngine::DirtyBackground	backgroundBrush()
QPaintEngine::DirtyBackgroundMode	backgroundMode()
QPaintEngine::DirtyBrush	brush()
QPaintEngine::DirtyBrushOrigin	brushOrigin()
QPaintEngine::DirtyClipRegion or QPaintEngine::DirtyClipPath	clipOperation()
QPaintEngine::DirtyClipPath	clipPath()
QPaintEngine::DirtyClipRegion	clipRegion()
QPaintEngine::DirtyCompositionMode	compositionMode()
QPaintEngine::DirtyFont	font()
QPaintEngine::DirtyTransform	transform()
QPaintEngine::DirtyClipEnabled	isClipEnabled()
QPaintEngine::DirtyPen	pen()
QPaintEngine::DirtyHints	renderHints()

The QPaintEngineState class also provide the painter() function which returns a pointer to the painter that is currently updating the paint engine.

An instance of this class, representing the current state of the active paint engine, is passed as argument to the QPaintEngine::updateState() function. The only situation in which you will have to use this class directly is when implementing your own paint engine.

Implementations

impl PaintEngineState

pub fn background_brush(&self) -> Brush

C++ method: QBrush QPaintEngineState::backgroundBrush() const

C++ documentation:

Returns the background brush in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyBackground flag.

See also state() and QPaintEngine::updateState().

pub fn background_mode(&self) -> BGMode

C++ method: Qt::BGMode QPaintEngineState::backgroundMode() const

C++ documentation:

Returns the background mode in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyBackgroundMode flag.

See also state() and QPaintEngine::updateState().

pub fn brush(&self) -> Brush

C++ method: QBrush QPaintEngineState::brush() const

C++ documentation:

Returns the brush in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyBrush flag.

See also state() and QPaintEngine::updateState().

pub fn brush_needs_resolving(&self) -> bool

C++ method: bool QPaintEngineState::brushNeedsResolving() const

C++ documentation:

Returns whether the coordinate of the fill have been specified as bounded by the current rendering operation and have to be resolved (about the currently rendered primitive).

This function was introduced in Qt 4.3.

pub fn brush_origin(&self) -> PointF

C++ method: QPointF QPaintEngineState::brushOrigin() const

C++ documentation:

Returns the brush origin in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyBrushOrigin flag.

See also state() and QPaintEngine::updateState().

pub fn clip_operation(&self) -> ClipOperation

C++ method: Qt::ClipOperation QPaintEngineState::clipOperation() const

C++ documentation:

Returns the clip operation in the current paint engine state.

This variable should only be used when the state() returns a combination which includes either the QPaintEngine::DirtyClipPath or the QPaintEngine::DirtyClipRegion flag.

See also state() and QPaintEngine::updateState().

pub fn clip_path(&self) -> PainterPath

C++ method: QPainterPath QPaintEngineState::clipPath() const

C++ documentation:

Returns the clip path in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyClipPath flag.

See also state() and QPaintEngine::updateState().

pub fn clip_region(&self) -> CppBox<Region>

C++ method: QRegion QPaintEngineState::clipRegion() const

C++ documentation:

Returns the clip region in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyClipRegion flag.

See also state() and QPaintEngine::updateState().

pub fn composition_mode(&self) -> CompositionMode

C++ method: QPainter::CompositionMode QPaintEngineState::compositionMode() const

C++ documentation:

Returns the composition mode in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyCompositionMode flag.

See also state() and QPaintEngine::updateState().

pub fn font(&self) -> Font

C++ method: QFont QPaintEngineState::font() const

C++ documentation:

Returns the font in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyFont flag.

See also state() and QPaintEngine::updateState().

pub fn is_clip_enabled(&self) -> bool

C++ method: bool QPaintEngineState::isClipEnabled() const

C++ documentation:

Returns whether clipping is enabled or not in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyClipEnabled flag.

See also state() and QPaintEngine::updateState().

pub fn matrix(&self) -> Matrix

C++ method: QMatrix QPaintEngineState::matrix() const

C++ documentation:

Returns the matrix in the current paint engine state.

Note: It is advisable to use transform() instead of this function to preserve the properties of perspective transformations.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyTransform flag.

This function was introduced in Qt 4.2.

See also state() and QPaintEngine::updateState().

pub fn opacity(&self) -> c_double

C++ method: double QPaintEngineState::opacity() const

C++ documentation:

Returns the opacity in the current paint engine state.

This function was introduced in Qt 4.2.

pub fn painter(&self) -> *mut Painter

C++ method: QPainter* QPaintEngineState::painter() const

C++ documentation:

Returns a pointer to the painter currently updating the paint engine.

pub fn pen(&self) -> Pen

C++ method: QPen QPaintEngineState::pen() const

C++ documentation:

Returns the pen in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyPen flag.

See also state() and QPaintEngine::updateState().

pub fn pen_needs_resolving(&self) -> bool

C++ method: bool QPaintEngineState::penNeedsResolving() const

C++ documentation:

Returns whether the coordinate of the stroke have been specified as bounded by the current rendering operation and have to be resolved (about the currently rendered primitive).

This function was introduced in Qt 4.3.

pub fn render_hints(&self) -> Flags<RenderHint>

C++ method: QFlags<QPainter::RenderHint> QPaintEngineState::renderHints() const

C++ documentation:

Returns the render hints in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyHints flag.

See also state() and QPaintEngine::updateState().

pub fn state(&self) -> Flags<DirtyFlag>

C++ method: QFlags<QPaintEngine::DirtyFlag> QPaintEngineState::state() const

C++ documentation:

Returns a combination of flags identifying the set of properties that need to be updated when updating the paint engine’s state (i.e. during a call to the QPaintEngine::updateState() function).

See also QPaintEngine::updateState().

pub fn transform(&self) -> Transform

C++ method: QTransform QPaintEngineState::transform() const

C++ documentation:

Returns the matrix in the current paint engine state.

This variable should only be used when the state() returns a combination which includes the QPaintEngine::DirtyTransform flag.

This function was introduced in Qt 4.3.

See also state() and QPaintEngine::updateState().

Trait Implementations

impl Drop for PaintEngineState

fn drop(&mut self)

C++ method: [destructor] void QPaintEngineState::~QPaintEngineState()

impl NewUninitialized for PaintEngineState

unsafe fn new_uninitialized() -> PaintEngineState

Creates new object with uninitialized internal buffer.