Engrave_Image: Functions to work with Engrave_Image blocks.
Data Structures | |
struct | _Engrave_Image |
Contains the needed image values. More... | |
Typedefs | |
typedef _Engrave_Image | Engrave_Image |
The Engrave_Image typedef. | |
Functions | |
EAPI Engrave_Image * | engrave_image_new (const char *name, Engrave_Image_Type type, double value) |
engrave_image_new - create a new Engrave_Image object. | |
EAPI Engrave_Image * | engrave_image_dup (Engrave_Image *from) |
engrave_image_dup - duplicate an Engrave_Image | |
EAPI void | engrave_image_free (Engrave_Image *ef) |
engrave_image_free - free the Engrave_Image | |
EAPI void | engrave_image_parent_set (Engrave_Image *ei, void *ef) |
engrave_image_parent_set - set the image parent pointer | |
EAPI void * | engrave_image_parent_get (Engrave_Image *ei) |
engrave_image_parent_get - get the parent of the image | |
EAPI const char * | engrave_image_name_get (Engrave_Image *ei) |
engrave_image_name_get - get the image name | |
EAPI Engrave_Image_Type | engrave_image_type_get (Engrave_Image *ei) |
engrave_image_type_get - get the type of the image | |
EAPI double | engrave_image_compression_value_get (Engrave_Image *ei) |
engrave_image_compression_value_get - get the image compression value |
Function Documentation
EAPI double engrave_image_compression_value_get | ( | Engrave_Image * | ei | ) |
engrave_image_compression_value_get - get the image compression value
- Parameters:
-
ei,: The Engrave_Image to get the value from
- Returns:
- Returns the compression value of the image or 0 if not set.
EAPI Engrave_Image* engrave_image_dup | ( | Engrave_Image * | from | ) |
engrave_image_dup - duplicate an Engrave_Image
- Parameters:
-
from,: The Engrave_Image to duplicate
- Returns:
- Returns a pointer to the newly allocated Engrave_Image on success or NULL on failure
EAPI void engrave_image_free | ( | Engrave_Image * | ei | ) |
engrave_image_free - free the Engrave_Image
- Parameters:
-
ei,: The Engrave_Image to free
- Returns:
- Returns no value.
EAPI const char* engrave_image_name_get | ( | Engrave_Image * | ei | ) |
engrave_image_name_get - get the image name
- Parameters:
-
ei,: The Engrave_Image to get the name from
- Returns:
- Returns the name of the image or NULL on failure.
EAPI Engrave_Image* engrave_image_new | ( | const char * | name, | |
Engrave_Image_Type | type, | |||
double | value | |||
) |
engrave_image_new - create a new Engrave_Image object.
- Parameters:
-
name,: The name of the given image type,: The Engrave_Image_Type of the given image. value,: A compression value for the given image (if applicable)
- Returns:
- Returns a pointer to a newly allocated Engrave_Image object on success or NULL on failure.
EAPI void* engrave_image_parent_get | ( | Engrave_Image * | ei | ) |
engrave_image_parent_get - get the parent of the image
- Parameters:
-
ei,: The Engrave_Image to get the parent from
- Returns:
- Returns the pointer to the Engrave_File parent or NULL if none set
EAPI void engrave_image_parent_set | ( | Engrave_Image * | ei, | |
void * | ef | |||
) |
engrave_image_parent_set - set the image parent pointer
- Parameters:
-
ei,: The Engrave_Image to set the parent into ef,: The Engrave_File to set as the parent
- Returns:
- Returns no value.
EAPI Engrave_Image_Type engrave_image_type_get | ( | Engrave_Image * | ei | ) |
engrave_image_type_get - get the type of the image
- Parameters:
-
ei,: The Engrave_Image to get the type from
- Returns:
- Returns the Engrave_Image_Type associated with ei or ENGRAVE_IMAGE_TYPE_NUM if the type is not set.