xtd::drawing::imaging::effects::posterize_effect Struct Reference

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

Definition

The xtd::drawing::imaging::effects::posterize_effect posterizes the image with color levels.

Namespace

xtd::drawing::imaging::effects

Library

xtd.drawing

Appearance

Original	Converted

Examples

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

const auto img = image::from_file("ball.png");
auto result = image_effector::set_effect(img, posterize_effect {2});
result.save("ball_posterize.png");

Public Properties
int32	levels
	Gets or sets the levels value (from 1 to 256).

Public Constructors
	posterize_effect ()=default
	Initialise the new instance of xtd::drawing::imaging::posterize_effect object.
	posterize_effect (int32 levels)
	Initialise the new instance of xtd::drawing::imaging::posterize_effect object with specified levels.

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

posterize_effect() [1/2]

xtd::drawing::imaging::effects::posterize_effect::posterize_effect ( )

default

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

posterize_effect() [2/2]

xtd::drawing::imaging::effects::posterize_effect::posterize_effect ( int32  levels )

explicit

Initialise the new instance of xtd::drawing::imaging::posterize_effect object with specified levels.

Parameters

levels

The levels value (from 1 to 256).

Remarks

If the level is equal to or greater than 256, the result is identical to the original image.

If the level is equal to or less than 1, the image is black.

Member Function Documentation

apply()

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

levels

int32 xtd::drawing::imaging::effects::posterize_effect::levels

Gets or sets the levels value (from 1 to 256).

Parameters

levels

The levels value (from 1 to 256).

Remarks

If the level is equal to or greater than 256, the result is identical to the original image.

If the level is equal to or less than 1, the image is black.

---

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

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