xtd::drawing::imaging::effects::disabled_effect Struct Reference

Inheritance diagram for xtd::drawing::imaging::effects::disabled_effect:

Definition

The xtd::drawing::imaging::effects::disabled_effect disables the image with brightness or background color.

Namespace

xtd::drawing::imaging::effects

Library

xtd.drawing

Appearance

Original	Converted

Examples

The following example code shows how tu use xtd::drawing::imaging::effects::disabled_effect with image.

const auto img = image::from_file("ball.png");
auto result = image_effector::set_effect(img, disabled_effect {back_color()});
result.save("ball_disable.png");

Public Properties
float	brightness
	Gets or sets the brightness.
void	back_color (const xtd::drawing::color &value)
	Sets the background color.

Public Constructors
	disabled_effect ()=default
	Initialise the new instance of xtd::drawing::imaging::disabled_effect object.
	disabled_effect (const xtd::drawing::color &back_color)
	Initialise the new instance of xtd::drawing::imaging::disabled_effect object with specified background color.
	disabled_effect (float brightness)
	Initialise the new instance of xtd::drawing::imaging::disabled_effect object with specified brightness.

Protected Methods
void	apply (xtd::drawing::image &image) const override
	Apply the effect.

Additional Inherited Members
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual xtd::size	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<class object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual xtd::string	to_string () const noexcept
	Returns a xtd::string that represents the current object.
Static Public Member Functions inherited from xtd::object
template<class object_a_t , class object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<class object_a_t , class object_b_t >
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.
Protected Member Functions inherited from xtd::drawing::imaging::effects::effect
Protected Member Functions inherited from xtd::abstract_object
	abstract_object ()=default
	Initializes a new instance of the xtd::abstract_object class.

Constructor & Destructor Documentation

disabled_effect() [1/3]

xtd::drawing::imaging::effects::disabled_effect::disabled_effect ( )

default

Initialise the new instance of xtd::drawing::imaging::disabled_effect object.

disabled_effect() [2/3]

xtd::drawing::imaging::effects::disabled_effect::disabled_effect ( const xtd::drawing::color &  back_color )

explicit

Initialise the new instance of xtd::drawing::imaging::disabled_effect object with specified background color.

Parameters

back_color

The background color.

disabled_effect() [3/3]

xtd::drawing::imaging::effects::disabled_effect::disabled_effect ( float  brightness )

explicit

Initialise the new instance of xtd::drawing::imaging::disabled_effect object with specified brightness.

Parameters

brightness

The brightness.

Member Function Documentation

back_color()

void xtd::drawing::imaging::effects::disabled_effect::back_color

(

const xtd::drawing::color &

value

)

Sets the background color.

Parameters

value

The background color.

apply()

void xtd::drawing::imaging::effects::disabled_effect::apply ( xtd::drawing::image &  image ) const

overrideprotectedvirtual

Apply the effect.

Parameters

graphics	The graphics to apply effect.
image	The image where the effect is applied.

Implements xtd::drawing::imaging::effects::effect.

Member Data Documentation

brightness

float xtd::drawing::imaging::effects::disabled_effect::brightness

Gets or sets the brightness.

Parameters

brightness

The brightness.

---

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

• xtd.drawing/include/xtd/drawing/imaging/effects/disabled_effect.hpp