CGPDFContentStream Reference

Overview

The CGPDFContentStreamRef opaque type provides access to the data that describes the appearance of a PDF page. A CGPDFContentStream object represents one or more PDF content streams for a page and their associated resource dictionaries. A PDF content stream is a sequential set of instructions that specifies how to paint items on a PDF page. A resource dictionary contains information needed by the content stream in order to decode the sequential instructions of the content stream.

CGPDFContentStream functions can retrieve both the content streams and the resource dictionaries associated with a PDF page.

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

Functions by Task

Creating a PDF Content Stream Object

• CGPDFContentStreamCreateWithPage
• CGPDFContentStreamCreateWithStream

Getting Data from a PDF Content Stream Object

• CGPDFContentStreamGetStreams
• CGPDFContentStreamGetResource

Retaining and Releasing a PDF Content Stream Object

• CGPDFContentStreamRetain
• CGPDFContentStreamRelease

Functions

CGPDFContentStreamCreateWithPage

Creates a content stream object from a PDF page object.

CGPDFContentStreamRef CGPDFContentStreamCreateWithPage (
   CGPDFPageRef page
);

CGPDFContentStreamCreateWithStream

Creates a PDF content stream object from an existing PDF content stream object.

CGPDFContentStreamRef CGPDFContentStreamCreateWithStream (
   CGPDFStreamRef stream,
   CGPDFDictionaryRef streamResources,
   CGPDFContentStreamRef parent
);

CGPDFContentStreamGetResource

Gets the specified resource from a PDF content stream object.

CGPDFObjectRef CGPDFContentStreamGetResource (
   CGPDFContentStreamRef cs,
   const char *category,
   const char *name
);

CGPDFContentStreamGetStreams

Gets the array of PDF content streams contained in a PDF content stream object.

CFArrayRef CGPDFContentStreamGetStreams (
   CGPDFContentStreamRef cs
);

CGPDFContentStreamRelease

Decrements the retain count of a PDF content stream object.

void CGPDFContentStreamRelease (
   CGPDFContentStreamRef cs
);

CGPDFContentStreamRetain

Increments the retain count of a PDF content stream object.

CGPDFContentStreamRef CGPDFContentStreamRetain (
   CGPDFContentStreamRef cs
);

Data Types

CGPDFContentStreamRef

An opaque type that provides access to the data that describes the appearance of a PDF page.

typedef struct CGPDFContentStream *CGPDFContentStreamRef;