Context Class Reference

Context provides a wrapper around the Core library context object. More...

#include <ImfContext.h>

Classes
struct	read_mode_t
struct	temp_mode_t
struct	write_mode_t

Public Member Functions
	Context ()
	Context (const char *filename, const ContextInitializer &ctxtinit, read_mode_t t)
	Context (const char *filename, const ContextInitializer &ctxtinit, temp_mode_t t)
	Context (const char *filename, const ContextInitializer &ctxtinit, write_mode_t t)
	operator exr_context_t () const noexcept
IMF_EXPORT void	setLongNameSupport (bool onoff)
IMF_EXPORT const char *	fileName () const
IMF_EXPORT int	version () const
IMF_EXPORT int	partCount () const
IMF_EXPORT exr_storage_t	storage (int partidx) const
IMF_EXPORT exr_attr_box2i_t	dataWindow (int partidx) const
IMF_EXPORT const exr_attr_chlist_t *	channels (int partidx) const
IMF_EXPORT bool	hasChannel (int partidx, const char *name) const
IMF_EXPORT const exr_attr_chlist_entry_t *	findChannel (int partidx, const char *name) const
IMF_EXPORT exr_lineorder_t	lineOrder (int partidx) const
IMF_EXPORT int	attrCount (int partidx) const
IMF_EXPORT const exr_attribute_t *	getAttr (int partidx, int attridx) const
IMF_EXPORT const exr_attribute_t *	getAttr (int partidx, const char *name) const
IMF_EXPORT Header	header (int partnum) const
IMF_EXPORT void	addHeader (int partnum, const Header &h)
IMF_EXPORT bool	chunkTableValid (int partidx) const

Detailed Description

Context provides a wrapper around the Core library context object.

This is the main vehicle by which the core library provides concurrent behavior, avoiding globals, and allowing each part of any application to use its own custom allocators or any other feature they prefer.

The context is logically comprised of referencing a file plus the additional helper utilities needed for doing so, and so should be the main entrypoint for querying any of the metadata for all the component parts of the file, along with the global header information.

Definition at line 30 of file ImfContext.h.

Constructor & Destructor Documentation

Context::Context

(

)

Context::Context	(	const char *	filename,
		const ContextInitializer &	ctxtinit,
		read_mode_t	t
	)

Context::Context	(	const char *	filename,
		const ContextInitializer &	ctxtinit,
		temp_mode_t	t
	)

Context::Context	(	const char *	filename,
		const ContextInitializer &	ctxtinit,
		write_mode_t	t
	)

Member Function Documentation

IMF_EXPORT void Context::addHeader	(	int	partnum,
		const Header &	h
	)

IMF_EXPORT int Context::attrCount

(

int

partidx

)

const

IMF_EXPORT const exr_attr_chlist_t* Context::channels

(

int

partidx

)

const

IMF_EXPORT bool Context::chunkTableValid

(

int

partidx

)

const

IMF_EXPORT exr_attr_box2i_t Context::dataWindow

(

int

partidx

)

const

IMF_EXPORT const char* Context::fileName

(

)

const

IMF_EXPORT const exr_attr_chlist_entry_t* Context::findChannel	(	int	partidx,
		const char *	name
	)		const

IMF_EXPORT const exr_attribute_t* Context::getAttr	(	int	partidx,
		int	attridx
	)		const

IMF_EXPORT const exr_attribute_t* Context::getAttr	(	int	partidx,
		const char *	name
	)		const

IMF_EXPORT bool Context::hasChannel	(	int	partidx,
		const char *	name
	)		const

IMF_EXPORT Header Context::header

(

int

partnum

)

const

IMF_EXPORT exr_lineorder_t Context::lineOrder

(

int

partidx

)

const

Context::operator exr_context_t ( ) const

inlinenoexcept

Definition at line 51 of file ImfContext.h.

IMF_EXPORT int Context::partCount

(

)

const

IMF_EXPORT void Context::setLongNameSupport

(

bool

onoff

)

IMF_EXPORT exr_storage_t Context::storage

(

int

partidx

)

const

IMF_EXPORT int Context::version

(

)

const

---

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

• OpenEXR/ImfContext.h