Struct PrSDKPPixSuite 

#[repr(C, packed(1))]
pub struct PrSDKPPixSuite {
    pub Dispose: Option<unsafe extern "C" fn(inPPixHand: PPixHand) -> prSuiteError>,
    pub GetPixels: Option<unsafe extern "C" fn(inPPixHand: PPixHand, inRequestedAccess: PrPPixBufferAccess, outPixelAddress: *mut *mut c_char) -> prSuiteError>,
    pub GetBounds: Option<unsafe extern "C" fn(inPPixHand: PPixHand, inoutBoundingRect: *mut prRect) -> prSuiteError>,
    pub GetRowBytes: Option<unsafe extern "C" fn(inPPixHand: PPixHand, outRowBytes: *mut csSDK_int32) -> prSuiteError>,
    pub GetPixelAspectRatio: Option<unsafe extern "C" fn(inPPixHand: PPixHand, outPixelAspectRatioNumerator: *mut csSDK_uint32, outPixelAspectRatioDenominator: *mut csSDK_uint32) -> prSuiteError>,
    pub GetPixelFormat: Option<unsafe extern "C" fn(inPPixHand: PPixHand, outPixelFormat: *mut PrPixelFormat) -> prSuiteError>,
    pub GetUniqueKey: Option<unsafe extern "C" fn(inPPixHand: PPixHand, inoutKeyBuffer: *mut c_uchar, inKeyBufferSize: usize) -> prSuiteError>,
    pub GetUniqueKeySize: Option<unsafe extern "C" fn(outKeyBufferSize: *mut usize) -> prSuiteError>,
    pub GetRenderTime: Option<unsafe extern "C" fn(inPPixHand: PPixHand, outRenderMilliseconds: *mut csSDK_int32) -> prSuiteError>,
}

Fields

Dispose: Option<unsafe extern "C" fn(inPPixHand: PPixHand) -> prSuiteError>

This will free this ppix. The ppix is no longer valid after this function is called.

@param inPPixHand The ppix handle you want to dispose.

GetPixels: Option<unsafe extern "C" fn(inPPixHand: PPixHand, inRequestedAccess: PrPPixBufferAccess, outPixelAddress: *mut *mut c_char) -> prSuiteError>

This will return a pointer to the pixel buffer.

@param inPPixHand The ppix handle you want to operate on. @param inRequestedAccess Requested pixel access. Most PPixs do not support write access modes. @param outPixelAddress The output pixel buffer address. May be NULL if the requested pixel access is not supported.

GetBounds: Option<unsafe extern "C" fn(inPPixHand: PPixHand, inoutBoundingRect: *mut prRect) -> prSuiteError>

This will return the bounding rect.

@param inPPixHand The ppix handle you want to operate on. @param outBoundingRect The address of a bounding rect to be filled in.

GetRowBytes: Option<unsafe extern "C" fn(inPPixHand: PPixHand, outRowBytes: *mut csSDK_int32) -> prSuiteError>

This will return the row bytes of the ppix.

@param inPPixHand The ppix handle you want to operate on. @param outRowBytes Returns how many bytes must be added to the pixel buffer address to get to the next line. May be negative.

GetPixelAspectRatio: Option<unsafe extern "C" fn(inPPixHand: PPixHand, outPixelAspectRatioNumerator: *mut csSDK_uint32, outPixelAspectRatioDenominator: *mut csSDK_uint32) -> prSuiteError>

This will return the pixel aspect ratio of this ppix.

@param inPPixHand The ppix handle you want to operate on. @param outPixelAspectRatioNumerator Returns the numerator of the pixel aspect ratio. @param outPixelAspectRatioDenominator Returns the denominator of the pixel aspect ratio.

GetPixelFormat: Option<unsafe extern "C" fn(inPPixHand: PPixHand, outPixelFormat: *mut PrPixelFormat) -> prSuiteError>

This will return the pixel format of this ppix.

@param inPPixHand The ppix handle you want to operate on. @param outPixelFormat Returns the pixel format of this ppix.

GetUniqueKey: Option<unsafe extern "C" fn(inPPixHand: PPixHand, inoutKeyBuffer: *mut c_uchar, inKeyBufferSize: usize) -> prSuiteError>

This will return the unique key for this ppix.

@param inPPixHand The ppix handle you want to operate on. @param outKeyBuffer Returns the pixel format of this ppix.

[TODO] Fill in returned error codes. @returns Error if the buffer size is too small (call GetUniqueKeySize() to get the correct size). @returns Error if the key is not available. @returns Success if the key data was filled in.

GetUniqueKeySize: Option<unsafe extern "C" fn(outKeyBufferSize: *mut usize) -> prSuiteError>

This will return the unique key size. This will not change for the entire run of the application.

@param outKeyBufferSize Returns the size of the ppix unique key.

GetRenderTime: Option<unsafe extern "C" fn(inPPixHand: PPixHand, outRenderMilliseconds: *mut csSDK_int32) -> prSuiteError>

This will return the render time for this ppix.

@param inPPixHand The ppix handle you want to operate on. @param outRenderMilliseconds Returns the render time in milliseconds. If the frame was cached, this time will be 0.

Trait Implementations

impl Clone for PrSDKPPixSuite

fn clone(&self) -> PrSDKPPixSuite

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrSDKPPixSuite

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

Formats the value using the given formatter.

impl Copy for PrSDKPPixSuite