EpImageFormat

Objective-C

struct
{
    /**
     * the size of the input image
     */
    CGSize imageSize;
    /**
     * Image orientation, Angles0 means head at the top, other angles mean counterlockwise rotation
     */
    EPOrientation orientation;
    /**
     * Resulting image orientation. If it matches the orientation then image will be returned in the same orientation.
     * Set to EPOrientationAngles0 to keep OEP default orientation.
     */
    EPOrientation resultedImageOrientation;
    /**
     * If YES, then the resulted image will be mirrored
     */
    BOOL isMirrored;
    /**
     * TODO: Add support to return YUV with Alpha. Returns BGRA since YUV-Alpha is not supported yet
     * Used for the cases when the returned image should include valid alpha channel
     */
    BOOL needAlphaInOutput;
    /**
     * Input image format determines output image format, conversion takes time. EffectPlayer produces images in RGBA, if you request BGRA the time to get BGRA is minimal.
     */
    BOOL overrideOutputToBGRA;
    /**
     * Omit conversion, returned pixel buffer is the CVPixelBuffer which is associated with Rendered Texture. The buffer type is BGRA, but texture is RGBA, so if such buffer is drawn without additional processing its colors will look unpredictably.
     */
    BOOL outputTexture;
}

Swift

struct EpImageFormat

Undocumented

  • the size of the input image

    Declaration

    Objective-C

    CGSize imageSize

    Swift

    var imageSize: CGSize

  • Image orientation, Angles0 means head at the top, other angles mean counterlockwise rotation

    Declaration

    Objective-C

    EPOrientation orientation

    Swift

    var orientation: EPOrientation

  • Resulting image orientation. If it matches the orientation then image will be returned in the same orientation. Set to EPOrientationAngles0 to keep OEP default orientation.

    Declaration

    Objective-C

    EPOrientation resultedImageOrientation

    Swift

    var resultedImageOrientation: EPOrientation

  • If YES, then the resulted image will be mirrored

    Declaration

    Objective-C

    BOOL isMirrored

    Swift

    var isMirrored: ObjCBool

  • TODO: Add support to return YUV with Alpha. Returns BGRA since YUV-Alpha is not supported yet Used for the cases when the returned image should include valid alpha channel

    Declaration

    Objective-C

    BOOL needAlphaInOutput

    Swift

    var needAlphaInOutput: ObjCBool

  • Input image format determines output image format, conversion takes time. EffectPlayer produces images in RGBA, if you request BGRA the time to get BGRA is minimal.

    Declaration

    Objective-C

    BOOL overrideOutputToBGRA

    Swift

    var overrideOutputToBGRA: ObjCBool

  • Omit conversion, returned pixel buffer is the CVPixelBuffer which is associated with Rendered Texture. The buffer type is BGRA, but texture is RGBA, so if such buffer is drawn without additional processing its colors will look unpredictably.

    Declaration

    Objective-C

    BOOL outputTexture

    Swift

    var outputTexture: ObjCBool