digiKam
Classes | Public Member Functions | Friends | List of all members
heif::Context Class Reference

Classes

class  EncodingOptions
 
class  Reader
 
class  ReadingOptions
 
class  Writer
 

Public Member Functions

void add_exif_metadata (const ImageHandle &master_image, const void *data, int size)
 
void add_XMP_metadata (const ImageHandle &master_image, const void *data, int size)
 
void assign_thumbnail (const ImageHandle &thumbnail_image, const ImageHandle &master_image)
 
 Context ()
 
ImageHandle encode_image (const Image &img, Encoder &encoder, const EncodingOptions &options=EncodingOptions())
 
ImageHandle encode_thumbnail (const Image &image, const ImageHandle &master_image, Encoder &encoder, const EncodingOptions &, int bbox_size)
 
ImageHandle get_image_handle (heif_item_id id) const
 
std::vector< heif_item_id > get_list_of_top_level_image_IDs () const noexcept
 
int get_number_of_top_level_images () const noexcept
 
ImageHandle get_primary_image_handle () const
 
heif_item_id get_primary_image_ID () const
 
bool is_top_level_image_ID (heif_item_id id) const noexcept
 
void read_from_file (std::string filename, const ReadingOptions &opts=ReadingOptions())
 
void read_from_memory (const void *mem, size_t size, const ReadingOptions &opts=ReadingOptions())
 
void read_from_memory_without_copy (const void *mem, size_t size, const ReadingOptions &opts=ReadingOptions())
 
void read_from_reader (Reader &, const ReadingOptions &opts=ReadingOptions())
 
void set_primary_image (ImageHandle &new_primary_image_handle)
 
void write (Writer &)
 
void write_to_file (std::string filename) const
 

Friends

struct ::heif_error heif_writer_trampoline_write (struct heif_context *ctx, const void *data, size_t size, void *userdata)
 

Constructor & Destructor Documentation

◆ Context()

heif::Context::Context ( )
inline

References heif_context_alloc(), and heif_context_free().

Member Function Documentation

◆ add_exif_metadata()

void heif::Context::add_exif_metadata ( const ImageHandle &  master_image,
const void *  data,
int  size 
)
inline

References heif::ImageHandle::get_raw_image_handle(), and heif_context_add_exif_metadata().

◆ add_XMP_metadata()

void heif::Context::add_XMP_metadata ( const ImageHandle &  master_image,
const void *  data,
int  size 
)
inline

References heif::ImageHandle::get_raw_image_handle(), and heif_context_add_XMP_metadata().

◆ assign_thumbnail()

void heif::Context::assign_thumbnail ( const ImageHandle &  thumbnail_image,
const ImageHandle &  master_image 
)
inline

References heif::ImageHandle::get_raw_image_handle(), and heif_context_assign_thumbnail().

◆ encode_image()

ImageHandle heif::Context::encode_image ( const Image &  img,
Encoder &  encoder,
const EncodingOptions &  options = EncodingOptions() 
)
inline

References heif_context_encode_image().

◆ encode_thumbnail()

ImageHandle heif::Context::encode_thumbnail ( const Image &  image,
const ImageHandle &  master_image,
Encoder &  encoder,
const EncodingOptions &  options,
int  bbox_size 
)
inline

References heif::ImageHandle::get_raw_image_handle(), heif_context_encode_thumbnail(), and heif_image_handle::image.

◆ get_image_handle()

ImageHandle heif::Context::get_image_handle ( heif_item_id  id) const
inline

References heif_context_get_image_handle().

◆ get_list_of_top_level_image_IDs()

std::vector< heif_item_id > heif::Context::get_list_of_top_level_image_IDs ( ) const
inlinenoexcept

References get_number_of_top_level_images(), and heif_context_get_list_of_top_level_image_IDs().

◆ get_number_of_top_level_images()

int heif::Context::get_number_of_top_level_images ( ) const
inlinenoexcept

References heif_context_get_number_of_top_level_images().

Referenced by get_list_of_top_level_image_IDs().

◆ get_primary_image_handle()

ImageHandle heif::Context::get_primary_image_handle ( ) const
inline

References heif_context_get_primary_image_handle().

◆ get_primary_image_ID()

heif_item_id heif::Context::get_primary_image_ID ( ) const
inline

References heif_context_get_primary_image_ID().

◆ is_top_level_image_ID()

bool heif::Context::is_top_level_image_ID ( heif_item_id  id) const
inlinenoexcept

References heif_context_is_top_level_image_ID().

◆ read_from_file()

void heif::Context::read_from_file ( std::string  filename,
const ReadingOptions &  opts = ReadingOptions() 
)
inline

References heif_context_read_from_file().

◆ read_from_memory()

void heif::Context::read_from_memory ( const void *  mem,
size_t  size,
const ReadingOptions &  opts = ReadingOptions() 
)
inline

References heif_context_read_from_memory().

◆ read_from_memory_without_copy()

void heif::Context::read_from_memory_without_copy ( const void *  mem,
size_t  size,
const ReadingOptions &  opts = ReadingOptions() 
)
inline

References heif_context_read_from_memory_without_copy().

◆ read_from_reader()

void heif::Context::read_from_reader ( Reader &  reader,
const ReadingOptions &  opts = ReadingOptions() 
)
inline

References heif_context_read_from_reader().

◆ set_primary_image()

void heif::Context::set_primary_image ( ImageHandle &  new_primary_image_handle)
inline

References heif::ImageHandle::get_raw_image_handle(), and heif_context_set_primary_image().

◆ write()

void heif::Context::write ( Writer &  writer)
inline

References heif_context_write().

◆ write_to_file()

void heif::Context::write_to_file ( std::string  filename) const
inline

References heif_context_write_to_file().

Friends And Related Function Documentation

◆ heif_writer_trampoline_write

struct ::heif_error heif_writer_trampoline_write ( struct heif_context *  ctx,
const void *  data,
size_t  size,
void *  userdata 
)
friend
The documentation for this class was generated from the following file: