Public Member Functions | Static Public Member Functions
efl::image Struct Reference

Class image. More...

Public Member Functions

 image (Eo *eo)
 Eo Constructor. More...
 
 image (std::nullptr_t)
 nullptr_t Constructor. More...
 
 image (image const &other)
 Copy Constructor.
 
bool animated_get () const
 Check if an image can be animated (have multiple frames) More...
 
void load_size_get (int *w_, int *h_) const
 
void load_size_set (int w_, int h_) const
 Set the loading size of an image. More...
 
bool smooth_scale_get () const
 Retrieves whether the given image is using high-quality image scaling algorithm. More...
 
void smooth_scale_set (bool smooth_scale_) const
 Sets whether to use high-quality image scaling algorithm on the given image. More...
 
double ratio_get () const
 The native ration of the image object. More...
 
 image (::efl::eo::parent_type _p)
 Constructs a new efl::image object. More...
 
- Public Member Functions inherited from efl::eo::concrete
 concrete (Eo *eo)
 Class constructor. More...
 
 concrete ()
 Default constructor. More...
 
 ~concrete ()
 Class destructor.
 
 concrete (concrete const &other)
 
 concrete (concrete &&other)
 
concreteoperator= (concrete const &other)
 Assignment operator.
 
concreteoperator= (concrete &&other)
 
Eo_eo_ptr () const
 Return a pointer to the EO Object stored in this instance. More...
 
Eo_release ()
 Releases the reference from this concrete object and return the pointer to the EO Object stored in this instance. More...
 
void _reset (Eo *_ptr=nullptr)
 Reset the current pointer to reference a new Eo object.
 
int ref_get () const
 Get the reference count of this object. More...
 
void parent_set (concrete parent)
 Set the parent of this object. More...
 
eina::optional< concreteparent_get ()
 Get the parent of this object. More...
 
Eo_Dbg_Info dbg_info_get ()
 Get debug information of this object. More...
 
 operator bool () const
 

Static Public Member Functions

static Eo_Class const * _eo_class ()
 

Additional Inherited Members

- Protected Attributes inherited from efl::eo::concrete
Eo_eo_raw
 The opaque EO Object.
 

Detailed Description

Class image.

Constructor & Destructor Documentation

efl::image::image ( ::efl::eo::parent_type  _p)
inlineexplicit

Constructs a new efl::image object.

Constructs a new efl::image object. If you want this object to be a child of another Eo object, use an efl::eo::parent expression, like the example.

Example:

efl::image my_image(efl::eo::parent = parent_object);
See also
image(Eo* eo)
efl::image::image ( Eo eo)
inlineexplicit

Eo Constructor.

Constructs the object from an Eo* pointer stealing its ownership.

Parameters
eoThe Eo object pointer.
efl::image::image ( std::nullptr_t  )
inlineexplicit

nullptr_t Constructor.

Constructs an empty (null) object.

Member Function Documentation

bool efl::image::animated_get ( ) const

Check if an image can be animated (have multiple frames)

Returns
whether the image support animation
Parameters
is_animatedIf it's animated or not.
void efl::image::load_size_get ( int *  w_,
int *  h_ 
) const
Parameters
wThe new width of the image's load size.
hThe new height of the image's load size.
void efl::image::load_size_set ( int  w_,
int  h_ 
) const

Set the loading size of an image.

The image will be loaded into memory as if it was the set size instead of the original size. This can save a lot of memory, and is important for scalable types like svg.

Parameters
wThe new width of the image's load size.
hThe new height of the image's load size.
bool efl::image::smooth_scale_get ( ) const

Retrieves whether the given image is using high-quality image scaling algorithm.

Returns
Whether smooth scale is being used.
Parameters
smooth_scaleWhether to use smooth scale or not.
void efl::image::smooth_scale_set ( bool  smooth_scale_) const

Sets whether to use high-quality image scaling algorithm on the given image.

When enabled, a higher quality image scaling algorithm is used when scaling images to sizes other than the source image's original one. This gives better results but is more computationally expensive.

Parameters
smooth_scaleWhether to use smooth scale or not.
double efl::image::ratio_get ( ) const

The native ration of the image object.

Parameters
ratioThe image's ratio