Contents

encodeRender(to:frameAttributes:sourceImage:sourceDisparity:destinationRGBA:)

Encode a command to render a shallow depth of field (SDoF) image to a metal texture as RGBA.

Declaration

func encodeRender(to commandBuffer: any MTLCommandBuffer, frameAttributes: CNRenderingSession.FrameAttributes, sourceImage: CVReadOnlyPixelBuffer, sourceDisparity: CVReadOnlyPixelBuffer? = nil, destinationRGBA: any MTLTexture) -> Bool

Parameters

  • commandBuffer:

    The metal command buffer on which to encode the command

  • frameAttributes:

    Controls the focus distance and aperture of the rendering

  • sourceImage:

    A pixel buffer read from the cinematicVideoTrack

  • sourceDisparity:

    A pixelbuffer with disparity. Can be nil only when preview rendering of assets before preprocessing (CNAssetInfo.cinematicCapability == .needsPreprocessing). When nil the source disparity and frameAttributes.focusDisparity will be computed internally. Passing nil for other types of assets will return false.

  • destinationRGBA:

    A metal texture to which the SDoF image is rendered in RGBA format

Return Value

Whether encoding the render command was successful