Struct

AppStreamComposeImageTarget

since: 1.2.0

Description [src]

struct AscImageTarget {
  /* No available fields */
}

Describes one requested output rendition of a media operation, and carries its result data after the operation was run. Renditions that were skipped due to one of their source-size conditions are not an error: the operation still succeeds, and %asc_image_target_get_skipped will return TRUE.

Available since: 1.2.0

Constructors

asc_image_target_new

Create a new AscImageTarget. The image format the rendition is stored in is derived from the file extension of name.

since: 1.2.0

Instance methods

asc_image_target_copy

Create a deep copy of an AscImageTarget, including any result data it may already carry.

since: 1.2.0

asc_image_target_free

Free an AscImageTarget. Bindings must not call this: they own the boxed value and release it themselves, so freeing it here would free it twice.

since: 1.2.0

asc_image_target_get_error_message

Get the error message in case creating this particular rendition failed. A failed rendition does not fail the media operation as a whole.

since: 1.2.0

asc_image_target_get_height

Get the requested height of this rendition. Depending on the scale mode, this may differ from the height the rendition is actually stored at.

since: 1.2.0

asc_image_target_get_name

Get the filename this rendition is stored as.

since: 1.2.0

asc_image_target_get_only_downscale

Get whether this rendition should be skipped rather than considering to upscale it to the target size(s).

since: 1.2.0

asc_image_target_get_result_height

Get the actual height of the stored rendition.

since: 1.2.0

asc_image_target_get_result_width

Get the actual width of the stored rendition.

since: 1.2.0

asc_image_target_get_save_flags

Get the flags used when storing this rendition.

since: 1.2.0

asc_image_target_get_scale_mode

Get the scaling mode this rendition is created with.

since: 1.2.0

asc_image_target_get_skipped

Check whether this rendition was skipped because the source image did not satisfy its source-size conditions. Only valid after the media operation this target was passed to has completed successfully.

since: 1.2.0

asc_image_target_get_source_size_range

Get the source image dimensions this rendition is restricted to. A value of 0 means that the respective dimension is not limited.

since: 1.2.0

asc_image_target_get_width

Get the requested width of this rendition. Depending on the scale mode, this may differ from the width the rendition is actually stored at.

since: 1.2.0

asc_image_target_set_only_downscale

Set whether this rendition should be skipped in case creating it would mean upscaling the source image.

since: 1.2.0

asc_image_target_set_save_flags

Set the flags used when storing this rendition.

since: 1.2.0

asc_image_target_set_source_size_range

Restrict the source images this rendition is created for. If the source image’s dimensions fall outside of the given range, the rendition is skipped and no file is written for it, while the media operation as a whole still succeeds.

since: 1.2.0