xtd::drawing::buffered_graphics Class Reference

Inheritance diagram for xtd::drawing::buffered_graphics:

Definition

Provides a graphics buffer for double buffering.

class drawing_export_ buffered_graphics : public xtd::object

Inheritance

xtd::object → xtd::drawing::buffered_graphics

Namespace

xtd::drawing

Library

xtd.drawing

Remarks

The xtd::drawing::buffered_graphics class allows you to implement custom double buffering for your graphics. It provides a wrapper for a graphics buffer, along with methods that you can use to write to the buffer and render its contents to an output device.

Graphics that use double buffering can reduce or eliminate flicker that is caused by redrawing a display surface. When you use double buffering, updated graphics are first drawn to a buffer in memory, and the contents of this buffer are then quickly written to some or all of the displayed surface. This relatively brief overwrite of the displayed graphics typically reduces or eliminates the flicker that sometimes occurs when graphics are updated.

Note

The simplest way to use double buffering is to set the xtd::forms::control_styles::optimized_double_buffer control style flag on a control using the xtd::control::set_style method. Setting the xtd::forms::control_styles::optimized_double_buffer flag for a control redirects all painting for the control through a default graphics buffer, without requiring any additional code. This flag is set to

`true` 

by default.

Remarks

The xtd::drawing::buffered_graphics class has no public constructor and must be created by the xtd::drawing::bffered_graphics_context for an application domain using its xtd::drawing::bffered_graphics_context::allocate method. You can retrieve the xtd::drawing::::buffered_graphics_context for the current application domain from the static xtd::drawing::buffered_graphics_manager::current property.

The xtd::drawing::graphics property can be used for drawing to the graphics buffer. This property provides access to the xtd::drawing::graphics object that draws to the graphics buffer allocated for this xtd::drawing::buffered_graphics object.

The xtd::drawing::buffered_graphics::render method with no arguments draws the contents of the graphics buffer to the surface specified when the buffer was allocated. Other overloads of the xtd::drawing::buffered_graphics::render method allow you to specify a xtd::drawing::graphics object or an xtd::intptr type that points to a device context to which to draw the contents of the graphics buffer.

Protected Member Functions
	buffered_graphics (const xtd::drawing::graphics &buffered_graphics_surface, std::optional< xtd::drawing::graphics > target_graphics, intptr target_dc, const xtd::drawing::point &target_location, xtd::drawing::size virtual_size)

Public Properties
auto	graphics () const noexcept -> const xtd::drawing::graphics &
	Gets a xtd::drawing::graphics object that outputs to the graphics buffer.
auto	graphics () noexcept -> xtd::drawing::graphics &

Public Methods
auto	render () -> void
	Writes the contents of the graphics buffer to the default device.
auto	render (xtd::drawing::graphics &target) -> void
	Writes the contents of the graphics buffer to the specified xtd::drawing::graphics object.
auto	render (intptr target_dc) -> void
	Writes the contents of the graphics buffer to the device context associated with the specified intptr handle.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	equals (const object &obj) const noexcept -> bool
	Determines whether the specified object is equal to the current object.
virtual auto	get_hash_code () const noexcept -> xtd::usize
	Serves as a hash function for a particular type.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	to_string () const -> xtd::string
	Returns a xtd::string that represents the current object.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

Member Function Documentation

graphics()

auto xtd::drawing::buffered_graphics::graphics ( ) const -> const xtd::drawing::graphics &

nodiscardnoexcept

Gets a xtd::drawing::graphics object that outputs to the graphics buffer.

Returns

A xtd::drawing::graphics object that outputs to the graphics buffer.

Remarks

This property provides a xtd::drawing::graphics object that draws to the graphics buffer allocated for this xtd::drawing::buffered_graphics object.

render() [1/3]

auto xtd::drawing::buffered_graphics::render

(

)

-> void

Writes the contents of the graphics buffer to the default device.

Remarks

This method writes the contents of the graphics buffer to the device specified by calling the xtd::drawing::bffered_graphics_context::allocate method of the xtd::drawing::bffered_graphics_context used to create this xtd::drawing::bffered_graphics object.

render() [2/3]

auto xtd::drawing::buffered_graphics::render

(

xtd::drawing::graphics &

target

)

-> void

Writes the contents of the graphics buffer to the specified xtd::drawing::graphics object.

Parameters

target

A xtd::drawing::graphics object to which to write the contents of the graphics buffer.

Remarks

This method writes the contents of the graphics buffer to the specified xtd::drawing::graphics object.

render() [3/3]

auto xtd::drawing::buffered_graphics::render

(

intptr

target_dc

)

-> void

Writes the contents of the graphics buffer to the device context associated with the specified intptr handle.

Parameters

target_dc

An intptr that points to the device context to which to write the contents of the graphics buffer.

Remarks

This method writes the contents of the graphics buffer to the device context associated with the specified intptr handle.

---

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

• xtd.drawing/include/xtd/drawing/buffered_graphics.hpp