[−][src]Struct ofx_sys::OfxPropertySuiteV1

#[repr(C)]

pub struct OfxPropertySuiteV1 {
    pub propSetPointer: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: *mut c_void) -> OfxStatus>,
    pub propSetString: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: *const c_char) -> OfxStatus>,
    pub propSetDouble: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: f64) -> OfxStatus>,
    pub propSetInt: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: c_int) -> OfxStatus>,
    pub propSetPointerN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *const *mut c_void) -> OfxStatus>,
    pub propSetStringN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *const *const c_char) -> OfxStatus>,
    pub propSetDoubleN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *const f64) -> OfxStatus>,
    pub propSetIntN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *const c_int) -> OfxStatus>,
    pub propGetPointer: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: *mut *mut c_void) -> OfxStatus>,
    pub propGetString: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: *mut *const c_char) -> OfxStatus>,
    pub propGetDouble: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: *mut f64) -> OfxStatus>,
    pub propGetInt: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: *mut c_int) -> OfxStatus>,
    pub propGetPointerN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *mut *mut c_void) -> OfxStatus>,
    pub propGetStringN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *mut *const c_char) -> OfxStatus>,
    pub propGetDoubleN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *mut f64) -> OfxStatus>,
    pub propGetIntN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *mut c_int) -> OfxStatus>,
    pub propReset: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char) -> OfxStatus>,
    pub propGetDimension: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: *mut c_int) -> OfxStatus>,
}

@brief The OFX suite used to access properties on OFX objects.

Fields

propSetPointer: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: *mut c_void) -> OfxStatus>

@brief Set a single value in a pointer property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg index is for multidimenstional properties and is dimension of the one we are setting \arg value is the value of the property we are setting

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
  • ::kOfxStatErrValue
propSetString: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: *const c_char) -> OfxStatus>

@brief Set a single value in a string property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg index is for multidimenstional properties and is dimension of the one we are setting \arg value is the value of the property we are setting

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
  • ::kOfxStatErrValue
propSetDouble: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: f64) -> OfxStatus>

@brief Set a single value in a double property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg index is for multidimenstional properties and is dimension of the one we are setting \arg value is the value of the property we are setting

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
  • ::kOfxStatErrValue
propSetInt: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: c_int) -> OfxStatus>

@brief Set a single value in an int property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg index is for multidimenstional properties and is dimension of the one we are setting \arg value is the value of the property we are setting

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
  • ::kOfxStatErrValue
propSetPointerN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *const *mut c_void) -> OfxStatus>

@brief Set multiple values of the pointer property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg count is the number of values we are setting in that property (ie: indicies 0..count-1) \arg value is a pointer to an array of property values

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
  • ::kOfxStatErrValue
propSetStringN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *const *const c_char) -> OfxStatus>

@brief Set multiple values of a string property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg count is the number of values we are setting in that property (ie: indicies 0..count-1) \arg value is a pointer to an array of property values

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
  • ::kOfxStatErrValue
propSetDoubleN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *const f64) -> OfxStatus>

@brief Set multiple values of a double property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg count is the number of values we are setting in that property (ie: indicies 0..count-1) \arg value is a pointer to an array of property values

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
  • ::kOfxStatErrValue
propSetIntN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *const c_int) -> OfxStatus>

@brief Set multiple values of an int property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg count is the number of values we are setting in that property (ie: indicies 0..count-1) \arg value is a pointer to an array of property values

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
  • ::kOfxStatErrValue
propGetPointer: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: *mut *mut c_void) -> OfxStatus>

@brief Get a single value from a pointer property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg index refers to the index of a multi-dimensional property \arg value is a pointer the return location

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
propGetString: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: *mut *const c_char) -> OfxStatus>

@brief Get a single value of a string property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg index refers to the index of a multi-dimensional property \arg value is a pointer the return location

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
propGetDouble: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: *mut f64) -> OfxStatus>

@brief Get a single value of a double property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg index refers to the index of a multi-dimensional property \arg value is a pointer the return location

See the note \ref ArchitectureStrings for how to deal with strings.

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
propGetInt: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, index: c_int, value: *mut c_int) -> OfxStatus>

@brief Get a single value of an int property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg index refers to the index of a multi-dimensional property \arg value is a pointer the return location

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
propGetPointerN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *mut *mut c_void) -> OfxStatus>

@brief Get multiple values of a pointer property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg count is the number of values we are getting of that property (ie: indicies 0..count-1) \arg value is a pointer to an array of where we will return the property values

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
propGetStringN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *mut *const c_char) -> OfxStatus>

@brief Get multiple values of a string property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg count is the number of values we are getting of that property (ie: indicies 0..count-1) \arg value is a pointer to an array of where we will return the property values

See the note \ref ArchitectureStrings for how to deal with strings.

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
propGetDoubleN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *mut f64) -> OfxStatus>

@brief Get multiple values of a double property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg count is the number of values we are getting of that property (ie: indicies 0..count-1) \arg value is a pointer to an array of where we will return the property values

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
propGetIntN: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: c_int, value: *mut c_int) -> OfxStatus>

@brief Get multiple values of an int property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property \arg count is the number of values we are getting of that property (ie: indicies 0..count-1) \arg value is a pointer to an array of where we will return the property values

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
  • ::kOfxStatErrBadIndex
propReset: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char) -> OfxStatus>

@brief Resets all dimensions of a property to its default value

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property we are resetting

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown
propGetDimension: Option<unsafe extern "C" fn(properties: OfxPropertySetHandle, property: *const c_char, count: *mut c_int) -> OfxStatus>

@brief Gets the dimension of the property

\arg properties is the handle of the thing holding the property \arg property is the string labelling the property we are resetting \arg count is a pointer to an integer where the value is returned

@returns

  • ::kOfxStatOK
  • ::kOfxStatErrBadHandle
  • ::kOfxStatErrUnknown

Trait Implementations

impl Clone for OfxPropertySuiteV1[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Copy for OfxPropertySuiteV1[src]

impl Debug for OfxPropertySuiteV1[src]

Auto Trait Implementations

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, [src]

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

impl<T> From for T[src]

impl<T, U> TryFrom for T where
    U: Into<T>, [src]

type Error = !

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized, [src]

impl<T> BorrowMut for T where
    T: ?Sized, [src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized, [src]