xtd::drawing::imaging::effects::opacity_effect Struct Reference

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

Definition

The xtd::drawing::imaging::effects::opacity_effect changes the opacity level of the image with percent factor.

Namespace

xtd::drawing::imaging::effects

Library

xtd.drawing

Appearance

Original	Converted

Examples

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

const auto img = image::from_file("ball.png");
auto result = image_effector::set_effect(img, opacity_effect {0.5});
result.save("ball_opacity.png");

Public Properties
double	percent
	Gets or sets the percent factor in %.

Public Constructors
	opacity_effect ()=default
	Initialise the new instance of xtd::drawing::imaging::opacity_effect object.
	opacity_effect (double percent)
	Initialise the new instance of xtd::drawing::imaging::opacity_effect object with specified percent.

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

opacity_effect() [1/2]

xtd::drawing::imaging::effects::opacity_effect::opacity_effect ( )

default

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

opacity_effect() [2/2]

xtd::drawing::imaging::effects::opacity_effect::opacity_effect ( double  percent )

explicit

Initialise the new instance of xtd::drawing::imaging::opacity_effect object with specified percent.

Parameters

percent

The percent factor in %.

Member Function Documentation

apply()

void xtd::drawing::imaging::effects::opacity_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

percent

double xtd::drawing::imaging::effects::opacity_effect::percent

Gets or sets the percent factor in %.

Parameters

percent

The percent factor in %.

Remarks

0.0 will represents a transparent image. 1.0 will provide the original image.

---

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

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