xtd::drawing::imaging::frame_dimension Class Reference

Inheritance diagram for xtd::drawing::imaging::frame_dimension:

Definition

Provides properties that get the frame dimensions of an image. Not inheritable.

Namespace

xtd::drawing::imaging

Library

xtd.drawing

Public Constructors
	frame_dimension (const xtd::guid &guid) noexcept
	Initializes a new instance of the FrameDimension class using the specified Guid structure.

Public Properties
auto	guid () const noexcept -> const xtd::guid &
	Gets a globally unique identifier (GUID) that represents this frame_dimension object.

Public Methods
auto	equals (const object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const frame_dimension &other) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	get_hash_code () const noexcept -> xtd::usize override
	Serves as a hash function for a particular type.

Public Static Properties
static auto	page () noexcept -> frame_dimension
	Gets the page dimension.
static auto	resolution () noexcept -> frame_dimension
	Gets the resolution dimension.
static auto	time () noexcept -> frame_dimension
	Gets the time dimension.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
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.
virtual auto	equals (const frame_dimension &) const noexcept -> bool=0
	Indicates whether the current object is equal to another object of the same type.
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.

Constructor & Destructor Documentation

frame_dimension()

xtd::drawing::imaging::frame_dimension::frame_dimension ( const xtd::guid & guid )

explicitnoexcept

Initializes a new instance of the FrameDimension class using the specified Guid structure.

Parameters

guid	A xtd::guid structure that contains a GUID for this frame_dimension object.

Member Function Documentation

guid()

auto xtd::drawing::imaging::frame_dimension::guid ( ) const -> const xtd::guid &

nodiscardnoexcept

Gets a globally unique identifier (GUID) that represents this frame_dimension object.

Returns

An xtd::guid structure that contains a GUID that represents this frame_dimension object.

page()

auto xtd::drawing::imaging::frame_dimension::page ( ) -> frame_dimension

staticnodiscardnoexcept

Gets the page dimension.

Returns

The page dimension.

resolution()

auto xtd::drawing::imaging::frame_dimension::resolution ( ) -> frame_dimension

staticnodiscardnoexcept

Gets the resolution dimension.

Returns

The resolution dimension.

time()

auto xtd::drawing::imaging::frame_dimension::time ( ) -> frame_dimension

staticnodiscardnoexcept

Gets the time dimension.

Returns

The time dimension.

equals() [1/2]

auto xtd::drawing::imaging::frame_dimension::equals ( const object & obj ) const -> bool

nodiscardoverridevirtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns

true if the specified object is equal to the current object. otherwise, false.

Reimplemented from xtd::object.

equals() [2/2]

auto xtd::drawing::imaging::frame_dimension::equals ( const frame_dimension & other ) const -> bool

nodiscardoverridenoexcept

Determines whether the specified object is equal to the current object.

Parameters

other

The object to compare with the current object.

Returns

true if the specified object is equal to the current object. otherwise, false.

get_hash_code()

auto xtd::drawing::imaging::frame_dimension::get_hash_code ( ) const -> xtd::usize

nodiscardoverridevirtualnoexcept

Serves as a hash function for a particular type.

Returns

A hash code for the current object.

Reimplemented from xtd::object.

---

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

• xtd.drawing/include/xtd/drawing/imaging/frame_dimension.hpp