ARView.PostProcessContext

struct · iOS 15.0+ · SDK 27.1

struct PostProcessContext

An object the framework uses to pass data to a postprocess callback. In iOS 15 and later, as well as macOS 12 and later, you can register a callback function to apply postprocessing effects to RealityKit’s rendered scene. Once every frame, RealityKit calls that function before it displays the scene. You can use this callback to apply postprocess effects using any APIs that can modify an image texture. However, because RealityKit calls this method every frame, you should only use APIs that execute on the GPU, such as Metal compute functions, <doc://com.apple.documentation/documentation/metalperformanceshaders>, or <doc://com.apple.documentation/coreimage>. You can also render additional content, such as a rendered SpriteKit scene, on top of the frame buffer. - Note: For more information on implementing postprocess effects, see <doc://com.apple.documentation/documentation/realitykit/implementing_special_rendering_effects_with_realitykit_postprocessing>, which demonstrates multiple postprocess techniques. A postprocess callback takes a single `PostProcessContext` parameter, which contains data the callback function needs to modify the rendered scene, including the frame buffer, depth map, and a property for writing the modified image. If you’ve registered a postprocess callback, that function needs to encode to the output texture or the frame is never displayed. A postprocess function looks like this: ```swift func myPostProcessCallback(context: ARView.PostProcessContext) { // Handle postprocessing here. } ``` To register a function as the postprocess render callback, assign it to the ``ARView/RenderCallbacks-swift.struct/postProcess`` property of the ``ARView/renderCallbacks-swift.property`` property of the scene’s `ARView`: ```swift arView.renderCallbacks.postProcess = myPostProcessCallback ``` To stop postprocessing, set the ``ARView/RenderCallbacks-swift.struct/postProcess`` render callback to `nil`. ```swift arView.renderCallbacks.postProcess = nil ``` If your app turns postprocessing on and off frequently, another option for disabling postprocess effects is to keep your callback registered, but use an <doc://com.apple.documentation/metal/mtlblitcommandencoder> to encode the unmodified framebuffer directly to the output texture whenever postprocess effects aren’t active. ```swift func myPostProcessCallback(context: ARView.PostProcessContext) { if (usePostProcessEffects) { handlePostProcessing(context: ARView.PostProcessContext) return } // If postprocess effects are disabled, copy sourceColorTexture // directly to targetColorTexture. let blitEncoder = context.commandBuffer.makeBlitCommandEncoder() blitEncoder?.copy(from: context.sourceColorTexture, to: context.targetColorTexture) blitEncoder?.endEncoding() } ```

Members (15)

get projection(): Promise<SDKHandle>

var projection: float4x4

setProjection(value: SDKHandle): Promise<void>

var projection: float4x4

get commandBuffer(): Promise<SDKHandle>

var commandBuffer: any MTLCommandBuffer

setCommandBuffer(value: SDKHandle): Promise<void>

var commandBuffer: any MTLCommandBuffer

get sourceColorTexture(): Promise<SDKHandle>

var sourceColorTexture: any MTLTexture

setSourceColorTexture(value: SDKHandle): Promise<void>

var sourceColorTexture: any MTLTexture

get sourceDepthTexture(): Promise<SDKHandle>

var sourceDepthTexture: any MTLTexture

setSourceDepthTexture(value: SDKHandle): Promise<void>

var sourceDepthTexture: any MTLTexture

get targetColorTexture(): Promise<SDKHandle>

var targetColorTexture: any MTLTexture

setTargetColorTexture(value: SDKHandle): Promise<void>

var targetColorTexture: any MTLTexture

get time(): Promise<number>

var time: TimeInterval

setTime(value: number): Promise<void>

var time: TimeInterval

get device(): Promise<SDKHandle>

var device: any MTLDevice

setDevice(value: SDKHandle): Promise<void>

var device: any MTLDevice

static init(device: SDKHandle, commandBuffer: SDKHandle, sourceColorTexture: SDKHandle, sourceDepthTexture: SDKHandle, targetColorTexture: SDKHandle, projection: SDKHandle, time: number): Promise<ARView_PostProcessContext>

init(_ device: any MTLDevice, _ commandBuffer: any MTLCommandBuffer, _ sourceColorTexture: any MTLTexture, _ sourceDepthTexture: any MTLTexture, _ targetColorTexture: any MTLTexture, _ projection: float4x4, _ time: TimeInterval)

All RealityKit types →