xtd::drawing::buffered_graphics_context Class Reference

Inheritance diagram for xtd::drawing::buffered_graphics_context:

Definition

Provides methods for creating graphics buffers that can be used for double buffering.

class drawing_export_ buffered_graphics_context : public xtd::object

Inheritance

xtd::object → xtd::drawing::buffered_graphics_context

Namespace

xtd::drawing

Library

xtd.drawing

Remarks

The xtd::drawing::buffered_graphics_context class allows you to implement custom double buffering for your graphics. Graphics that use double buffering can reduce or eliminate flicker that is caused by redrawing a display surface.

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::forms::control::set_style method. Setting the xtd::forms::control_styles::optimized_double_buffer control styles 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_context class provides methods for creating and configuring a graphics buffer. The xtd::drawing::buffered_graphics_context::allocate method creates a xtd::drawing::buffered_graphics, which is a wrapper for a graphics buffer that also provides methods you can use to write to the buffer and render its contents to an output device.

You can retrieve the xtd::drawing::buffered_graphics_context for the current application domain from the static xtd::drawing::buffered_graphics_manager::current property. For graphically intensive applications such as animation, you can create a dedicated xtd::drawing::buffered_graphics_context using the constructor, but for most applications the xtd::drawing::buffered_graphics_manager::current property will be sufficient.

Public Constructors
	buffered_graphics_context ()=default
	Initializes a new instance of the BufferedGraphicsContext class.

Public Properties
auto	maximum_buffer () const noexcept -> const xtd::drawing::size &
	Gets the maximum size of the buffer to use.
auto	maximum_buffer (const xtd::drawing::size &value) -> buffered_graphics_context &
	Sets the maximum size of the buffer to use.

Public Methods
auto	allocate (const xtd::drawing::graphics &target_graphics, const xtd::drawing::rectangle &targat_rectangle) -> void
auto	allocate (intptr target_dc, const xtd::drawing::rectangle &targat_rectangle) -> void
void	invalidate ()
	Destroy of the current graphics buffer, if a buffer has been allocated and has not yet been destroyed.

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.

Constructor & Destructor Documentation

buffered_graphics_context()

xtd::drawing::buffered_graphics_context::buffered_graphics_context ( )

default

Initializes a new instance of the BufferedGraphicsContext class.

Remarks

For graphically intensive applications such as animation, you can sometimes improve performance by using a dedicated xtd::drawing::buffered_graphics_context instead of the default instance provided by the xtd::drawing::buffered_graphics_manager. This allows you to create and manage graphics buffers individually.

Member Function Documentation

maximum_buffer() [1/2]

auto xtd::drawing::buffered_graphics_context::maximum_buffer ( ) const -> const xtd::drawing::size &

nodiscardnoexcept

Gets the maximum size of the buffer to use.

Returns

A xtd::drawing::size indicating the maximum size of the buffer dimensions.

Remarks

This property allows you to get or set the maximum dimensions for a buffer that should be retained in memory. You can allocate a buffer of any size, however any buffer with dimensions greater than the xtd::drawing::buffered_graphics_context::MaximumBuffer size will be used temporarily and then discarded when the xtd::drawing::buffered_graphics object is released.

maximum_buffer() [2/2]

auto xtd::drawing::buffered_graphics_context::maximum_buffer

(

const xtd::drawing::size &

value

)

-> buffered_graphics_context &

Sets the maximum size of the buffer to use.

Parameters

value

A xtd::drawing::size indicating the maximum size of the buffer dimensions.

Exceptions

xtd::argument_exception

The height or width of the size is less than or equal to zero.

Remarks

This property allows you to get or set the maximum dimensions for a buffer that should be retained in memory. You can allocate a buffer of any size, however any buffer with dimensions greater than the xtd::drawing::buffered_graphics_context::MaximumBuffer size will be used temporarily and then discarded when the xtd::drawing::buffered_graphics object is released.

invalidate()

void xtd::drawing::buffered_graphics_context::invalidate

(

)

Destroy of the current graphics buffer, if a buffer has been allocated and has not yet been destroyed.

Remarks

If the graphics buffer is in use, it will be marked for destroying as soon as it is free; otherwise, it will be destoyed immediately.

---

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

• xtd.drawing/include/xtd/drawing/buffered_graphics_context.hpp