iOS Developer Library

Developer

Core Text Reference Collection CGPDFStream Reference

Options
Deployment Target:

On This Page
Language:

CGPDFStream Reference

The CGPDFStreamRef opaque type represents a PDF stream. A PDF stream consists of a dictionary that describes a sequence of bytes. Streams typically represent objects with potentially large amounts of data, such as images and page descriptions.

This opaque type is not derived from CFType and therefore there are no functions for retaining and releasing it.

Functions

Data Types

  • An opaque type that represents a PDF stream.

    Declaration

    Swift

    typealias CGPDFStreamRef = COpaquePointer

    Objective-C

    typedef struct CGPDFStream *CGPDFStreamRef;

    Import Statement

    Objective-C

    @import CoreGraphics;

    Swift

    import CoreGraphics

    Availability

    Available in iOS 2.0 and later.

Constants

  • The encoding format of PDF data.

    Declaration

    Swift

    enum CGPDFDataFormat : Int32 { case Raw case JPEGEncoded case JPEG2000 }

    Objective-C

    enum CGPDFDataFormat { CGPDFDataFormatRaw, CGPDFDataFormatJPEGEncoded, CGPDFDataFormatJPEG2000 }; typedef enum CGPDFDataFormat CGPDFDataFormat;

    Constants

    • Raw

      CGPDFDataFormatRaw

      The data stream is not encoded.

      Available in iOS 2.0 and later.

    • JPEGEncoded

      CGPDFDataFormatJPEGEncoded

      The data stream is encoded in JPEG format.

      Available in iOS 2.0 and later.

    • JPEG2000

      CGPDFDataFormatJPEG2000

      The data stream is encoded in JPEG-2000 format.

      Available in iOS 2.0 and later.

    Import Statement

    Objective-C

    @import CoreGraphics;

    Swift

    import CoreGraphics

    Availability

    Available in iOS 2.0 and later.