OFX::ImageEffectHostDescription Struct Reference

A class that lists all the properties of a host. More...

#include <ofxsImageEffect.h>

Public Types
typedef std::vector < EPixelComponent >	PixelComponentArray
typedef std::vector< EContext >	ContextArray
typedef std::vector< EBitDepth >	BitDepthArray
Public Member Functions
bool	supportsPixelComponent (const OFX::EPixelComponent component) const
bool	supportsBitDepth (const OFX::EBitDepth bitDepth) const
bool	supportsContext (const OFX::EContext context) const
EBitDepth	getPixelDepth () const
Data Fields
std::string	hostName
std::string	hostLabel
bool	hostIsBackground
bool	supportsOverlays
bool	supportsMultiResolution
bool	supportsTiles
bool	temporalClipAccess
bool	supportsMultipleClipDepths
bool	supportsMultipleClipPARs
bool	supportsSetableFrameRate
bool	supportsSetableFielding
bool	supportsStringAnimation
bool	supportsCustomInteract
bool	supportsChoiceAnimation
bool	supportsBooleanAnimation
bool	supportsCustomAnimation
bool	supportsParametricParameter
bool	supportsCameraParameter
int	maxParameters
int	maxPages
int	pageRowCount
int	pageColumnCount
PixelComponentArray	_supportedComponents
ContextArray	_supportedContexts
BitDepthArray	_supportedPixelDepths
bool	supportsProgressSuite
bool	supportsTimeLineSuite

---

Detailed Description

A class that lists all the properties of a host.

Definition at line 256 of file ofxsImageEffect.h.

---

Member Typedef Documentation

typedef std::vector<EBitDepth> OFX::ImageEffectHostDescription::BitDepthArray

Definition at line 285 of file ofxsImageEffect.h.

typedef std::vector<EContext> OFX::ImageEffectHostDescription::ContextArray

Definition at line 283 of file ofxsImageEffect.h.

typedef std::vector<EPixelComponent> OFX::ImageEffectHostDescription::PixelComponentArray

Definition at line 281 of file ofxsImageEffect.h.

---

Member Function Documentation

EBitDepth OFX::ImageEffectHostDescription::getPixelDepth

(

)

const [inline]

Returns:

the pixel depth used by host application, if it doesn't support multiple clip depth.

Definition at line 305 of file ofxsImageEffect.h.

References _supportedPixelDepths, OFX::eBitDepthFloat, and OFXS_COUT_WARNING.

Referenced by OFX::ClipPreferencesSetter::setClipBitDepth().

bool OFX::ImageEffectHostDescription::supportsBitDepth

(

const OFX::EBitDepth

bitDepth

)

const [inline]

Definition at line 295 of file ofxsImageEffect.h.

References _supportedPixelDepths.

bool OFX::ImageEffectHostDescription::supportsContext

(

const OFX::EContext

context

)

const [inline]

Definition at line 299 of file ofxsImageEffect.h.

References _supportedContexts.

bool OFX::ImageEffectHostDescription::supportsPixelComponent

(

const OFX::EPixelComponent

component

)

const [inline]

Definition at line 291 of file ofxsImageEffect.h.

References _supportedComponents.

---

Field Documentation

PixelComponentArray OFX::ImageEffectHostDescription::_supportedComponents

Definition at line 282 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), OFX::Private::fetchHostDescription(), and supportsPixelComponent().

ContextArray OFX::ImageEffectHostDescription::_supportedContexts

Definition at line 284 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), OFX::Private::fetchHostDescription(), and supportsContext().

BitDepthArray OFX::ImageEffectHostDescription::_supportedPixelDepths

Definition at line 286 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), OFX::Private::fetchHostDescription(), getPixelDepth(), tuttle::plugin::swscale::SwscalePlugin::render(), and supportsBitDepth().

bool OFX::ImageEffectHostDescription::hostIsBackground

Definition at line 261 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

std::string OFX::ImageEffectHostDescription::hostLabel

Definition at line 260 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

std::string OFX::ImageEffectHostDescription::hostName

Definition at line 259 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

int OFX::ImageEffectHostDescription::maxPages

Definition at line 278 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

int OFX::ImageEffectHostDescription::maxParameters

Definition at line 277 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

int OFX::ImageEffectHostDescription::pageColumnCount

Definition at line 280 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

int OFX::ImageEffectHostDescription::pageRowCount

Definition at line 279 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

bool OFX::ImageEffectHostDescription::supportsBooleanAnimation

Definition at line 273 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

bool OFX::ImageEffectHostDescription::supportsCameraParameter

Definition at line 276 of file ofxsImageEffect.h.

Referenced by OFX::Private::fetchHostDescription().

bool OFX::ImageEffectHostDescription::supportsChoiceAnimation

Definition at line 272 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

bool OFX::ImageEffectHostDescription::supportsCustomAnimation

Definition at line 274 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

bool OFX::ImageEffectHostDescription::supportsCustomInteract

Definition at line 271 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

bool OFX::ImageEffectHostDescription::supportsMultipleClipDepths

Definition at line 266 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), OFX::Private::fetchHostDescription(), and OFX::ClipPreferencesSetter::setClipBitDepth().

bool OFX::ImageEffectHostDescription::supportsMultipleClipPARs

Definition at line 267 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), OFX::Private::fetchHostDescription(), and OFX::ClipPreferencesSetter::setPixelAspectRatio().

bool OFX::ImageEffectHostDescription::supportsMultiResolution

Definition at line 263 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

bool OFX::ImageEffectHostDescription::supportsOverlays

Definition at line 262 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

bool OFX::ImageEffectHostDescription::supportsParametricParameter

Definition at line 275 of file ofxsImageEffect.h.

Referenced by OFX::Private::fetchHostDescription().

bool OFX::ImageEffectHostDescription::supportsProgressSuite

Definition at line 287 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::loadAction().

bool OFX::ImageEffectHostDescription::supportsSetableFielding

Definition at line 269 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

bool OFX::ImageEffectHostDescription::supportsSetableFrameRate

Definition at line 268 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), OFX::Private::fetchHostDescription(), and OFX::ClipPreferencesSetter::setOutputFrameRate().

bool OFX::ImageEffectHostDescription::supportsStringAnimation

Definition at line 270 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

bool OFX::ImageEffectHostDescription::supportsTiles

Definition at line 264 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

bool OFX::ImageEffectHostDescription::supportsTimeLineSuite

Definition at line 288 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::loadAction().

bool OFX::ImageEffectHostDescription::temporalClipAccess

Definition at line 265 of file ofxsImageEffect.h.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), and OFX::Private::fetchHostDescription().

---

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

• libraries/openfxHack/Support/include/ofxsImageEffect.h