OfxPropertySuiteV1

Struct OfxPropertySuiteV1 

Source
#[repr(C)]
pub struct OfxPropertySuiteV1 {
Show 18 fields 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 *mut 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 *mut 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>,
}
Expand description

@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 *mut 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 *mut 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§

Source§

impl Clone for OfxPropertySuiteV1

Source§

fn clone(&self) -> OfxPropertySuiteV1

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for OfxPropertySuiteV1

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Copy for OfxPropertySuiteV1

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.