xtd::drawing::imaging::effects::grayscale_effect Struct Reference

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

Definition

The xtd::drawing::imaging::effects::grayscale_effect changes the colors of the image to grayscale colors 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::grayscale_effect with image.

const auto img = image::from_file("ball.png");
auto result = image_effector::set_effect(img, grayscale_effect {1.0});
result.save("ball_grayscale.png");

Examples

image_effects.cpp.

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

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

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

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.
	abstract_object ()=default
	Initializes a new instance of the xtd::abstract_object class.

Constructor & Destructor Documentation

grayscale_effect() [1/2]

xtd::drawing::imaging::effects::grayscale_effect::grayscale_effect ( )

default

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

grayscale_effect() [2/2]

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

explicit

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

Parameters

percent

The percent factor in %.

Member Function Documentation

apply()

auto xtd::drawing::imaging::effects::grayscale_effect::apply ( xtd::drawing::image & image ) const -> void

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::grayscale_effect::percent

Gets or sets the percent factor in %.

Parameters

percent

The percent factor in %.

Remarks

Thus, 1.0 will make the color completely gray, while 0.0 return the original image.

---

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

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