xtd 0.2.0
xtd::drawing::imaging::effects::contrast_effect Struct Reference
Inheritance diagram for xtd::drawing::imaging::effects::contrast_effect:
xtd::drawing::imaging::effects::effect xtd::abstract_object xtd::object

Definition

The xtd::drawing::imaging::effects::brightness_effect changes the contrast 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::contrast_effect with image.
const auto img = image::from_file("ball.png");
auto result = image_effector::set_effect(img, contrast_effect {200});
result.save("ball_contrast.png");
void save(const xtd::string &filename) const
Saves this xtd::drawing::image to the specified file or stream.
static image from_file(const xtd::string &filename)
Creates an image from the specified file.
static xtd::drawing::image set_effect(const xtd::drawing::image &image, const xtd::drawing::imaging::effects::effect &effect)
Sets the specified effects to the specifid image.
The xtd::drawing::imaging::effects::brightness_effect changes the contrast of the image with percent ...
Definition contrast_effect.hpp:34

Public Properties

double percent
 Gets or sets the percent factor in %.
 

Public Constructors

 contrast_effect ()=default
 Initialise the new instance of xtd::drawing::imaging::contrast_effect object.
 
 contrast_effect (double percent)
 Initialise the new instance of xtd::drawing::imaging::contrast_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

◆ contrast_effect() [1/2]

xtd::drawing::imaging::effects::contrast_effect::contrast_effect ( )
default

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

◆ contrast_effect() [2/2]

xtd::drawing::imaging::effects::contrast_effect::contrast_effect ( double  percent)
explicit

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

Parameters
percentThe percent factor in %.

Member Function Documentation

◆ apply()

void xtd::drawing::imaging::effects::contrast_effect::apply ( xtd::drawing::image image) const
overrideprotectedvirtual

Apply the effect.

Parameters
graphicsThe graphics to apply effect.
imageThe image where the effect is applied.

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

Member Data Documentation

◆ percent

double xtd::drawing::imaging::effects::contrast_effect::percent

Gets or sets the percent factor in %.

Parameters
percentThe percent factor in %.
Remarks
0.0 will make the image completely black. 1.0 is default and represents the original image. Values over 1.0 will provide brighter results.

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