mpsrayintersector

func (Acl_entry_id_t) String ¶

func (e Acl_entry_id_t) String() string

func (Acl_flag_t) String ¶

func (e Acl_flag_t) String() string

func (Acl_perm_t) String ¶

func (e Acl_perm_t) String() string

func (Acl_tag_t) String ¶

func (e Acl_tag_t) String() string

func (Acl_type_t) String ¶

func (e Acl_type_t) String() string

func (Clockid_t) String ¶

func (e Clockid_t) String() string

func (Dispatch_autorelease_frequency_t) String ¶

func (e Dispatch_autorelease_frequency_t) String() string

func (Dispatch_block_flags_t) String ¶

func (e Dispatch_block_flags_t) String() string

func (Filesec_property_t) String ¶

func (e Filesec_property_t) String() string

func (Idtype_t) String ¶

func (e Idtype_t) String() string

func (Ipc_info_object_type_t) String ¶

func (e Ipc_info_object_type_t) String() string

func (Launch_data_type_t) String ¶

func (e Launch_data_type_t) String() string

func (MDLabelDomain) String ¶

func (e MDLabelDomain) String() string

func (MDQueryOptionFlags) String ¶

func (e MDQueryOptionFlags) String() string

func (MDQuerySortOptionFlags) String ¶

func (e MDQuerySortOptionFlags) String() string

func (*MPSAccelerationStructure) BoundingBox ¶

func (o *MPSAccelerationStructure) BoundingBox() MPSAxisAlignedBoundingBox

@brief The bounding box fully enclosing the geometry this acceleration structure was built over. @discussion The value of this property is not available until the acceleration structure has finished rebuilding or refitting

func (*MPSAccelerationStructure) CopyWithZoneGroup ¶

func (o *MPSAccelerationStructure) CopyWithZoneGroup(zone unsafe.Pointer, group *MPSAccelerationStructureGroup) *MPSAccelerationStructure

@brief Create a a copy of this acceleration structure @discussion The acceleration structure may be copied with a different acceleration structure group. Buffer properties of the acceleration structure such as the vertex buffer, instance buffer, etc. are set to nil. Copy these buffers with the new Metal device and assign them to the new acceleration structure instead. Do not copy the acceleration structure until any prior refit or rebuild operations have completed. @param zone This parameter is ignored. Memory zones are no longer used by Objective-C. @param group New acceleration structure group

func (*MPSAccelerationStructure) EncodeRefitToCommandBuffer ¶

func (o *MPSAccelerationStructure) EncodeRefitToCommandBuffer(commandBuffer metal.MTLCommandBuffer)

@brief Refit the existing acceleration structure to new data @discussion This method is used to refit the acceleration structure to new vertex data, index data, instance data, etc. while preserving the existing acceleration structure topology. This is typically much faster than a full rebuild of the acceleration structure. Refitting can also be pipelined with other GPU work such as ray intersection. Until the command buffer has completed, the acceleration structure cannot be copied, encoded with NSSecureCoding, or rebuilt. Changes to properties such as the triangle count or instance count might not be reflected. These changes require that the acceleration structure be rebuilt instead. The acceleration structure must be rebuilt at least once before this method can be called.

func (*MPSAccelerationStructure) EncodeWithCoder ¶

func (o *MPSAccelerationStructure) EncodeWithCoder(coder *foundation.NSCoder)

@brief Encode the acceleration structure with an NSCoder @discussion Buffer properties such as the vertex buffer, index buffer, etc. are not be encoded. Encode and decode these buffers along with the acceleration structure instead. Do not encode the acceleration structure until any prior refit or rebuild operations have completed. @param coder An archiver object

func (*MPSAccelerationStructure) Group ¶

func (o *MPSAccelerationStructure) Group() *MPSAccelerationStructureGroup

@brief The group this acceleration structure was created with

func (*MPSAccelerationStructure) InitWithCoderDevice ¶

func (o *MPSAccelerationStructure) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSAccelerationStructure

@brief Initialize the acceleration structure with an NSCoder and a Metal device. Buffer properties such as the vertex buffer, instance buffer, etc. are set to nil. Encode and decode these buffers along with the acceleration structure instead.

func (*MPSAccelerationStructure) InitWithCoderGroup ¶

func (o *MPSAccelerationStructure) InitWithCoderGroup(aDecoder *foundation.NSCoder, group *MPSAccelerationStructureGroup) *MPSAccelerationStructure

@brief Initialize the acceleration structure with an NSCoder and an acceleration structure group, if the acceleration structure will be used in an instance hierarchy. All acceleration structures in the instance hierarchy must share the same group. Buffer properties such as the vertex buffer, instance buffer, etc. are set to nil. Encode and decode these buffers along with the acceleration structure instead.

func (*MPSAccelerationStructure) InitWithDevice ¶

func (o *MPSAccelerationStructure) InitWithDevice(device metal.MTLDevice) *MPSAccelerationStructure

@brief Initialize the acceleration structure with a Metal device

func (*MPSAccelerationStructure) InitWithGroup ¶

func (o *MPSAccelerationStructure) InitWithGroup(group *MPSAccelerationStructureGroup) *MPSAccelerationStructure

@brief Initialize the acceleration structure with an acceleration structure group, if the acceleration structure will be used in an instance hierarchy. @discussion The Metal device is determined from the acceleration structure group. All acceleration structures in the instance hierarchy must share the same group.

func (*MPSAccelerationStructure) Rebuild ¶

func (o *MPSAccelerationStructure) Rebuild()

@brief Rebuild the acceleration structure @discussion This method must be called before any intersection tests can be scheduled with this acceleration structure. Before calling this method, fill out the properties of the acceleration structure such as vertex buffer, instance buffer, etc. The acceleration structure should be rebuilt when its contents (e.g. vertices in a triangle acceleration structure) have been modified significantly and must be rebuilt when properties such as triangle count, vertex stride, etc. have changed. When the contents of the acceleration structure have only been modified slightly, it may be cheaper to refit the acceleration structure instead. This method blocks until the acceleration structure has been rebuilt. Until the rebuild has completed, the acceleration structure cannot be copied, encoded with NSSecureCoding, rebuilt, or refit. Before this method can be called, any pending GPU writes to the vertex buffer, index buffer, etc. must be completed (and, for managed buffers, synchronized). Any prior intersection tests must also be completed before the acceleration structure can be rebuilt.

func (*MPSAccelerationStructure) RebuildWithCompletionHandler ¶

func (o *MPSAccelerationStructure) RebuildWithCompletionHandler(completionHandler func(*MPSAccelerationStructure))

@brief Rebuild the acceleration structure asynchronously @discussion This method must be called before any intersection tests can be scheduled with this acceleration structure. Before calling this method, fill out the properties of the acceleration structure such as vertex buffer, instance buffer, etc. The acceleration structure should be rebuilt when its contents (e.g. vertices in a triangle acceleration structure) have been modified significantly and must be rebuilt when properties such as triangle count, vertex stride, etc. have changed. When the contents of the acceleration structure have only been modified slightly, it may be cheaper to refit the acceleration structure instead. Until the rebuild has completed, the acceleration structure cannot be copied, encoded with NSSecureCoding, rebuilt, or refit. Before this method can be called, any pending GPU writes to the vertex buffer, index buffer, etc. must be completed (and, for managed buffers, synchronized). Any prior intersection tests must also be completed before the acceleration structure can be rebuilt.

func (*MPSAccelerationStructure) SetUsage ¶

func (o *MPSAccelerationStructure) SetUsage(usage MPSAccelerationStructureUsage)

func (*MPSAccelerationStructure) Status ¶

func (o *MPSAccelerationStructure) Status() MPSAccelerationStructureStatus

@brief Status indicating whether the acceleration structure has finished building

func (*MPSAccelerationStructure) Usage ¶

func (o *MPSAccelerationStructure) Usage() MPSAccelerationStructureUsage

@brief Acceleration structure usage options. Changes to this property require rebuilding the acceleration structure. Defaults to MPSAccelerationStructureUsageNone.

func (*MPSAccelerationStructureGroup) Device ¶

func (o *MPSAccelerationStructureGroup) Device() metal.MTLDevice

@brief The Metal device this acceleration structure group was created with

func (*MPSAccelerationStructureGroup) InitWithDevice ¶

func (o *MPSAccelerationStructureGroup) InitWithDevice(device metal.MTLDevice) *MPSAccelerationStructureGroup

func (MPSAccelerationStructureStatus) String ¶

func (e MPSAccelerationStructureStatus) String() string

func (MPSAccelerationStructureUsage) String ¶

func (e MPSAccelerationStructureUsage) String() string

func (MPSBoundingBoxIntersectionTestType) String ¶

func (e MPSBoundingBoxIntersectionTestType) String() string

func (*MPSInstanceAccelerationStructure) AccelerationStructures ¶

func (o *MPSInstanceAccelerationStructure) AccelerationStructures() *foundation.NSArray[*MPSPolygonAccelerationStructure]

@brief Acceleration structures available for use in this instance acceleration structure. Each instance must provide an index into this array in the instance buffer as well as a transformation matrix in the transform buffer. All acceleration structures must share a single vertex buffer, optional index buffer, and optional mask buffer, though they may have different offsets within each buffer, and all acceleration structures must share the same acceleration structure group. If a polygon acceleration structure is rebuilt or refit, the instance acceleration structure must subsequently be rebuilt or refit.

func (*MPSInstanceAccelerationStructure) InstanceBuffer ¶

func (o *MPSInstanceAccelerationStructure) InstanceBuffer() metal.MTLBuffer

@brief Buffer containing the 32 bit unsigned integer index into the acceleration structure array for each instance

func (*MPSInstanceAccelerationStructure) InstanceBufferOffset ¶

func (o *MPSInstanceAccelerationStructure) InstanceBufferOffset() uint

@brief Offset, in bytes, into the instance buffer. Defaults to 0 bytes. Must be aligned to 4 bytes.

func (*MPSInstanceAccelerationStructure) InstanceCount ¶

func (o *MPSInstanceAccelerationStructure) InstanceCount() uint

@brief Number of instances. Changes to this property require rebuilding the acceleration structure.

func (*MPSInstanceAccelerationStructure) MaskBuffer ¶

func (o *MPSInstanceAccelerationStructure) MaskBuffer() metal.MTLBuffer

@brief Mask buffer containing one uint32_t mask per instance. May be nil.

func (*MPSInstanceAccelerationStructure) MaskBufferOffset ¶

func (o *MPSInstanceAccelerationStructure) MaskBufferOffset() uint

@brief Offset, in bytes, into the mask buffer. Defaults to 0 bytes. Must be aligned to 4 bytes.

func (*MPSInstanceAccelerationStructure) SetAccelerationStructures ¶

func (o *MPSInstanceAccelerationStructure) SetAccelerationStructures(accelerationStructures *foundation.NSArray[*MPSPolygonAccelerationStructure])

func (*MPSInstanceAccelerationStructure) SetInstanceBuffer ¶

func (o *MPSInstanceAccelerationStructure) SetInstanceBuffer(instanceBuffer metal.MTLBuffer)

func (*MPSInstanceAccelerationStructure) SetInstanceBufferOffset ¶

func (o *MPSInstanceAccelerationStructure) SetInstanceBufferOffset(instanceBufferOffset uint)

func (*MPSInstanceAccelerationStructure) SetInstanceCount ¶

func (o *MPSInstanceAccelerationStructure) SetInstanceCount(instanceCount uint)

func (*MPSInstanceAccelerationStructure) SetMaskBuffer ¶

func (o *MPSInstanceAccelerationStructure) SetMaskBuffer(maskBuffer metal.MTLBuffer)

func (*MPSInstanceAccelerationStructure) SetMaskBufferOffset ¶

func (o *MPSInstanceAccelerationStructure) SetMaskBufferOffset(maskBufferOffset uint)

func (*MPSInstanceAccelerationStructure) SetTransformBuffer ¶

func (o *MPSInstanceAccelerationStructure) SetTransformBuffer(transformBuffer metal.MTLBuffer)

func (*MPSInstanceAccelerationStructure) SetTransformBufferOffset ¶

func (o *MPSInstanceAccelerationStructure) SetTransformBufferOffset(transformBufferOffset uint)

func (*MPSInstanceAccelerationStructure) SetTransformType ¶

func (o *MPSInstanceAccelerationStructure) SetTransformType(transformType MPSTransformType)

func (*MPSInstanceAccelerationStructure) TransformBuffer ¶

func (o *MPSInstanceAccelerationStructure) TransformBuffer() metal.MTLBuffer

@brief Buffer containing one column major matrix_float4x4 transformation matrix per instance

func (*MPSInstanceAccelerationStructure) TransformBufferOffset ¶

func (o *MPSInstanceAccelerationStructure) TransformBufferOffset() uint

@brief Offset, in bytes, into the transform buffer. Defaults to 0 bytes. Must be aligned to the stride of the transform type.

func (*MPSInstanceAccelerationStructure) TransformType ¶

func (o *MPSInstanceAccelerationStructure) TransformType() MPSTransformType

@brief Instance transform type. Defaults to MPSTransformTypeFloat4x4. Changes to this property require rebuilding the acceleration structure.

func (MPSIntersectionDataType) String ¶

func (e MPSIntersectionDataType) String() string

func (MPSIntersectionType) String ¶

func (e MPSIntersectionType) String() string

func (*MPSPolygonAccelerationStructure) IndexBuffer ¶

func (o *MPSPolygonAccelerationStructure) IndexBuffer() metal.MTLBuffer

@brief Index buffer containing index data. Each index references a vertex in the vertex buffer. May be nil. This is an alias for polygonBuffers[0].indexBuffer. There must be exactly one polygon buffer to use this property, or the polygonBuffers property must be nil, in which case an MPSPolygonBuffer will be created automatically.

func (*MPSPolygonAccelerationStructure) IndexBufferOffset ¶

func (o *MPSPolygonAccelerationStructure) IndexBufferOffset() uint

@brief Offset, in bytes, into the index buffer. Defaults to 0 bytes. Must be aligned to a multiple of the index type. Changes to this property require rebuilding the acceleration structure. This is an alias for polygonBuffers[0].indexBufferOffset. There must be exactly one polygon buffer to use this property, or the polygonBuffers property must be nil, in which case an MPSPolygonBuffer will be created automatically.

func (*MPSPolygonAccelerationStructure) IndexType ¶

func (o *MPSPolygonAccelerationStructure) IndexType() mpscore.MPSDataType

@brief Index type. Defaults to MPSDataTypeUInt32. Only MPSDataTypeUInt16 and MPSDataTypeUInt32 are supported.

func (*MPSPolygonAccelerationStructure) MaskBuffer ¶

func (o *MPSPolygonAccelerationStructure) MaskBuffer() metal.MTLBuffer

@brief Mask buffer containing one uint32_t mask per polygon. May be nil. Otherwise, the mask type must be specified on the MPSRayIntersector with which it is used. This is an alias for polygonBuffers[0].maskBuffer. There must be exactly one polygon buffer to use this property, or the polygonBuffers property must be nil, in which case an MPSPolygonBuffer will be created automatically.

func (*MPSPolygonAccelerationStructure) MaskBufferOffset ¶

func (o *MPSPolygonAccelerationStructure) MaskBufferOffset() uint

@brief Offset, in bytes, into the mask buffer. Defaults to 0 bytes. Must be aligned to 4 bytes. This is an alias for polygonBuffers[0].maskBufferOffset. There must be exactly one polygon buffer to use this property, or the polygonBuffers property must be nil, in which case an MPSPolygonBuffer will be created automatically.

func (*MPSPolygonAccelerationStructure) PolygonBuffers ¶

func (o *MPSPolygonAccelerationStructure) PolygonBuffers() *foundation.NSArray[*MPSPolygonBuffer]

@brief Array of polygon buffers. Each buffer contains a vertex buffer and optional index and mask buffer for an array of polygons. Changing the length of this array requires rebuilding the acceleration structure. Using more than one MPSPolygonBuffer will reduce performance. It is better to concatenate these buffers into a single vertex buffer, index buffer, and mask buffer and use a single MPSPolygonBuffer if possible. This also applies when using an MPSInstanceAccelerationStructure: each instance or subclass of MPSPolygonAccelerationStructure in an instance hierarchy should use the same vertex buffer, index buffer, and mask buffer, although each acceleration structure may use different offsets into these buffers. This allows for the vertex, index, and mask buffers to be bound directly instead of indirectly through an argument buffer. There must be at least one MPSPolygonBuffer. On argument buffer tier 1 devices, there must be be exactly one MPSPolygonBuffer. Use the argumentBuffersSupport property of the MTLDevice to check for support.

func (*MPSPolygonAccelerationStructure) PolygonCount ¶

func (o *MPSPolygonAccelerationStructure) PolygonCount() uint

@brief Number of polygons. Changes to this property require rebuilding the acceleration structure. This is an alias for polygonBuffers[0].polygonCount. There must be exactly one polygon buffer to use this property, or the polygonBuffers property must be nil, in which case an MPSPolygonBuffer will be created automatically.

func (*MPSPolygonAccelerationStructure) PolygonType ¶

func (o *MPSPolygonAccelerationStructure) PolygonType() MPSPolygonType

@brief The type of polygon. Defaults to MPSPolygonTypeTriangle. Changes to this property require rebuilding the acceleration structure.

func (*MPSPolygonAccelerationStructure) SetIndexBuffer ¶

func (o *MPSPolygonAccelerationStructure) SetIndexBuffer(indexBuffer metal.MTLBuffer)

func (*MPSPolygonAccelerationStructure) SetIndexBufferOffset ¶

func (o *MPSPolygonAccelerationStructure) SetIndexBufferOffset(indexBufferOffset uint)

func (*MPSPolygonAccelerationStructure) SetIndexType ¶

func (o *MPSPolygonAccelerationStructure) SetIndexType(indexType mpscore.MPSDataType)

func (*MPSPolygonAccelerationStructure) SetMaskBuffer ¶

func (o *MPSPolygonAccelerationStructure) SetMaskBuffer(maskBuffer metal.MTLBuffer)

func (*MPSPolygonAccelerationStructure) SetMaskBufferOffset ¶

func (o *MPSPolygonAccelerationStructure) SetMaskBufferOffset(maskBufferOffset uint)

func (*MPSPolygonAccelerationStructure) SetPolygonBuffers ¶

func (o *MPSPolygonAccelerationStructure) SetPolygonBuffers(polygonBuffers *foundation.NSArray[*MPSPolygonBuffer])

func (*MPSPolygonAccelerationStructure) SetPolygonCount ¶

func (o *MPSPolygonAccelerationStructure) SetPolygonCount(polygonCount uint)

func (*MPSPolygonAccelerationStructure) SetPolygonType ¶

func (o *MPSPolygonAccelerationStructure) SetPolygonType(polygonType MPSPolygonType)

func (*MPSPolygonAccelerationStructure) SetVertexBuffer ¶

func (o *MPSPolygonAccelerationStructure) SetVertexBuffer(vertexBuffer metal.MTLBuffer)

func (*MPSPolygonAccelerationStructure) SetVertexBufferOffset ¶

func (o *MPSPolygonAccelerationStructure) SetVertexBufferOffset(vertexBufferOffset uint)

func (*MPSPolygonAccelerationStructure) SetVertexStride ¶

func (o *MPSPolygonAccelerationStructure) SetVertexStride(vertexStride uint)

func (*MPSPolygonAccelerationStructure) VertexBuffer ¶

func (o *MPSPolygonAccelerationStructure) VertexBuffer() metal.MTLBuffer

@brief Vertex buffer containing vertex data encoded as three 32 bit floats per vertex. Note that by default each vertex is aligned to the alignment of the vector_float3 type: 16 bytes. This can be changed using the vertexStride property. A vertex buffer must be provided before the acceleration structure is built. When using triangle polygons, degenerate (zero or negative area) triangles are ignored during acceleration structure construction. This can be used to pad triangle indices if needed. Quadrilateral polygons are internally treated as two triangles. If the quadrilateral has vertices v0, v1, v2, and v3, the two triangles will have vertices v0, v1, v2 and v0, v2, v3. A quadrilateral may be used to represent a triangle by repeating the last vertex. If the first triangle is degenerate (zero or negative area), the entire quadrilateral will be ignored. This can be used to pad quadrilateral indices if needed. All four vertices of a quadrilateral must be coplanar and the quadrilateral must be convex. This is an alias for polygonBuffers[0].vertexBuffer. There must be exactly one polygon buffer to use this property, or the polygonBuffers property must be nil, in which case an MPSPolygonBuffer will be created automatically.

func (*MPSPolygonAccelerationStructure) VertexBufferOffset ¶

func (o *MPSPolygonAccelerationStructure) VertexBufferOffset() uint

@brief Offset, in bytes, into the vertex buffer. Defaults to 0 bytes. Must be aligned to 4 bytes. This is an alias for polygonBuffers[0].vertexBufferOffset. There must be exactly one polygon buffer to use this property, or the polygonBuffers property must be nil, in which case an MPSPolygonBuffer will be created automatically.

func (*MPSPolygonAccelerationStructure) VertexStride ¶

func (o *MPSPolygonAccelerationStructure) VertexStride() uint

@brief Offset, in bytes, between consecutive vertices in the vertex buffer. Defaults to 0 bytes, indicating that the vertices are packed according to the natural alignment of the vector_float3 type: 16 bytes. @discussion This can be used to skip past any additional per-vertex data which may be stored alongside the position such as the vertex normal and texture coordinates. Must be a multiple of 4 bytes, and must be at least 12 bytes. Changes to this property require rebuilding the acceleration structure.

func (*MPSPolygonBuffer) IndexBuffer ¶

func (o *MPSPolygonBuffer) IndexBuffer() metal.MTLBuffer

@brief Index buffer containing index data. Each index references a vertex in the vertex buffer. May be nil.

func (*MPSPolygonBuffer) IndexBufferOffset ¶

func (o *MPSPolygonBuffer) IndexBufferOffset() uint

@brief Offset, in bytes, into the index buffer. Defaults to 0 bytes. Must be aligned to a multiple of the index type. Changes to this property require rebuilding the acceleration structure.

func (*MPSPolygonBuffer) Init ¶

func (o *MPSPolygonBuffer) Init() *MPSPolygonBuffer

@brief Initialize the polygon buffer

func (*MPSPolygonBuffer) InitWithCoder ¶

func (o *MPSPolygonBuffer) InitWithCoder(aDecoder *foundation.NSCoder) *MPSPolygonBuffer

@brief Initialize the polygon buffer with an NSCoder. Buffer properties such as the vertex buffer, instance buffer, etc. are set to nil. Encode and decode these buffers along with the polygon buffer instead.

func (*MPSPolygonBuffer) MaskBuffer ¶

func (o *MPSPolygonBuffer) MaskBuffer() metal.MTLBuffer

@brief Mask buffer containing one uint32_t mask per polygon. May be nil. Otherwise, the mask type must be specified on the MPSRayIntersector with which it is used.

func (*MPSPolygonBuffer) MaskBufferOffset ¶

func (o *MPSPolygonBuffer) MaskBufferOffset() uint

@brief Offset, in bytes, into the mask buffer. Defaults to 0 bytes. Must be aligned to 4 bytes.

func (*MPSPolygonBuffer) PolygonCount ¶

func (o *MPSPolygonBuffer) PolygonCount() uint

@brief Number of polygons. Changes to this property require rebuilding the acceleration structure.

func (*MPSPolygonBuffer) SetIndexBuffer ¶

func (o *MPSPolygonBuffer) SetIndexBuffer(indexBuffer metal.MTLBuffer)

func (*MPSPolygonBuffer) SetIndexBufferOffset ¶

func (o *MPSPolygonBuffer) SetIndexBufferOffset(indexBufferOffset uint)

func (*MPSPolygonBuffer) SetMaskBuffer ¶

func (o *MPSPolygonBuffer) SetMaskBuffer(maskBuffer metal.MTLBuffer)

func (*MPSPolygonBuffer) SetMaskBufferOffset ¶

func (o *MPSPolygonBuffer) SetMaskBufferOffset(maskBufferOffset uint)

func (*MPSPolygonBuffer) SetPolygonCount ¶

func (o *MPSPolygonBuffer) SetPolygonCount(polygonCount uint)

func (*MPSPolygonBuffer) SetVertexBuffer ¶

func (o *MPSPolygonBuffer) SetVertexBuffer(vertexBuffer metal.MTLBuffer)

func (*MPSPolygonBuffer) SetVertexBufferOffset ¶

func (o *MPSPolygonBuffer) SetVertexBufferOffset(vertexBufferOffset uint)

func (*MPSPolygonBuffer) VertexBuffer ¶

func (o *MPSPolygonBuffer) VertexBuffer() metal.MTLBuffer

@brief Vertex buffer containing vertex data encoded as three 32 bit floats per vertex. Note that by default each vertex is aligned to the alignment of the vector_float3 type: 16 bytes. This can be changed using the vertexStride property. A vertex buffer must be provided before the acceleration structure is built. When using triangle polygons, degenerate (zero or negative area) triangles are ignored during acceleration structure construction. This can be used to pad triangle indices if needed. Quadrilateral polygons are internally treated as two triangles. If the quadrilateral has vertices v0, v1, v2, and v3, the two triangles will have vertices v0, v1, v2 and v0, v2, v3. A quadrilateral may be used to represent a triangle by repeating the last vertex. If the first triangle is degenerate (zero or negative area), the entire quadrilateral will be ignored. This can be used to pad quadrilateral indices if needed. All four vertices of a quadrilateral must be coplanar and the quadrilateral must be convex.

func (*MPSPolygonBuffer) VertexBufferOffset ¶

func (o *MPSPolygonBuffer) VertexBufferOffset() uint

@brief Offset, in bytes, into the vertex buffer. Defaults to 0 bytes. Must be aligned to 4 bytes.

func (MPSPolygonType) String ¶

func (e MPSPolygonType) String() string

func (*MPSQuadrilateralAccelerationStructure) QuadrilateralCount ¶

func (o *MPSQuadrilateralAccelerationStructure) QuadrilateralCount() uint

@brief Number of quads. Changes to this property require rebuilding the acceleration structure. This is an alias for the polygonCount property.

func (*MPSQuadrilateralAccelerationStructure) SetQuadrilateralCount ¶

func (o *MPSQuadrilateralAccelerationStructure) SetQuadrilateralCount(quadrilateralCount uint)

func (MPSRayDataType) String ¶

func (e MPSRayDataType) String() string

func (*MPSRayIntersector) BoundingBoxIntersectionTestType ¶

func (o *MPSRayIntersector) BoundingBoxIntersectionTestType() MPSBoundingBoxIntersectionTestType

@brief Ray/bounding box intersection test type. Defaults to MPSBoundingBoxIntersectionTestTypeDefault.

func (*MPSRayIntersector) CullMode ¶

func (o *MPSRayIntersector) CullMode() metal.MTLCullMode

@brief Whether to ignore intersections between rays and back-facing or front-facing triangles or quadrilaterals. Defaults to MTLCullModeNone. @discussion A triangle or quadrilateral is back-facing if its normal points in the same direction as a ray and front-facing if its normal points in the opposite direction as a ray. If the cull mode is set to MTLCullModeBack, then back-facing triangles and quadrilaterals will be ignored. If the cull mode is set to MTLCullModeFront, then front-facing triangles and quadrilaterals will be ignored. Otherwise, if the cull mode is set to MTLCullModeNone, no triangles or quadrilaterals will be ignored. The front and back faces can be swapped using the frontFacingWinding property. Backface culling is necessary for some scenes but can reduce raytracing performance.

func (*MPSRayIntersector) EncodeIntersectionToCommandBufferIntersectionTypeRayBufferRayBufferOffsetIntersectionBufferIntersectionBufferOffsetRayCountAccelerationStructure ¶

func (o *MPSRayIntersector) EncodeIntersectionToCommandBufferIntersectionTypeRayBufferRayBufferOffsetIntersectionBufferIntersectionBufferOffsetRayCountAccelerationStructure(commandBuffer metal.MTLCommandBuffer, intersectionType MPSIntersectionType, rayBuffer metal.MTLBuffer, rayBufferOffset uint, intersectionBuffer metal.MTLBuffer, intersectionBufferOffset uint, rayCount uint, accelerationStructure *MPSAccelerationStructure)

@brief Schedule intersection tests between rays and an acceleration structure @param commandBuffer Command buffer to schedule intersection testing in @param intersectionType Which type of intersection to test for @param rayBuffer Buffer containing rays to intersect against the acceleration structure. The ray data type is defined by the rayDataType and rayStride properties. @param rayBufferOffset Offset, in bytes, into the ray buffer. Must be a multiple of the ray stride. @param intersectionBuffer Buffer to store intersection in. Intersections are stored in the same order as the ray buffer, one intersection per ray. The intersection data type is defined by the intersectionDataType and intersectionStride properties. @param intersectionBufferOffset Offset, in bytes, into the intersection buffer. Must be a multiple of the intersection stride. @param rayCount Number of rays @param accelerationStructure Acceleration structure to test against

func (*MPSRayIntersector) EncodeIntersectionToCommandBufferIntersectionTypeRayBufferRayBufferOffsetIntersectionBufferIntersectionBufferOffsetRayCountBufferRayCountBufferOffsetAccelerationStructure ¶

func (o *MPSRayIntersector) EncodeIntersectionToCommandBufferIntersectionTypeRayBufferRayBufferOffsetIntersectionBufferIntersectionBufferOffsetRayCountBufferRayCountBufferOffsetAccelerationStructure(commandBuffer metal.MTLCommandBuffer, intersectionType MPSIntersectionType, rayBuffer metal.MTLBuffer, rayBufferOffset uint, intersectionBuffer metal.MTLBuffer, intersectionBufferOffset uint, rayCountBuffer metal.MTLBuffer, rayCountBufferOffset uint, accelerationStructure *MPSAccelerationStructure)

@brief Schedule intersection tests between rays and an acceleration structure with a ray count provided in a buffer @param commandBuffer Command buffer to schedule intersection testing in @param intersectionType Which type of intersection to test for @param rayBuffer Buffer containing rays to intersect against the acceleration structure. The ray data type is defined by the rayDataType and rayStride properties. @param rayBufferOffset Offset, in bytes, into the ray buffer. Must be a multiple of the ray stride. @param intersectionBuffer Buffer to store intersection in. Intersections are stored in the same order as the ray buffer, one intersection per ray. The intersection data type is defined by the intersectionDataType and intersectionStride properties. @param intersectionBufferOffset Offset, in bytes, into the intersection buffer. Must be a multiple of the intersection stride. @param rayCountBuffer Buffer containing number of rays as a 32 bit unsigned integer @param rayCountBufferOffset Offset, in bytes, into the ray count buffer. Must be a multiple of 4 bytes. @param accelerationStructure Acceleration structure to test against

func (*MPSRayIntersector) EncodeIntersectionToCommandBufferIntersectionTypeRayBufferRayBufferOffsetRayIndexBufferRayIndexBufferOffsetIntersectionBufferIntersectionBufferOffsetRayIndexCountAccelerationStructure ¶

func (o *MPSRayIntersector) EncodeIntersectionToCommandBufferIntersectionTypeRayBufferRayBufferOffsetRayIndexBufferRayIndexBufferOffsetIntersectionBufferIntersectionBufferOffsetRayIndexCountAccelerationStructure(commandBuffer metal.MTLCommandBuffer, intersectionType MPSIntersectionType, rayBuffer metal.MTLBuffer, rayBufferOffset uint, rayIndexBuffer metal.MTLBuffer, rayIndexBufferOffset uint, intersectionBuffer metal.MTLBuffer, intersectionBufferOffset uint, rayIndexCount uint, accelerationStructure *MPSAccelerationStructure)

@brief Schedule intersection tests between rays and an acceleration structure @param commandBuffer Command buffer to schedule intersection testing in @param intersectionType Which type of intersection to test for @param rayBuffer Buffer containing rays to intersect against the acceleration structure. The ray data type is defined by the rayDataType and rayStride properties. @param rayBufferOffset Offset, in bytes, into the ray buffer. Must be a multiple of the ray stride. @param rayIndexBuffer Buffer containing ray indices. Each index references a ray in the ray buffer. The ray index data type is controlled by the rayIndexDataType property. @param rayIndexBufferOffset Offset, in bytes, into the ray index buffer. Must be a multiple of the stride of the ray index type. @param intersectionBuffer Buffer to store intersection in. Intersections are stored in the same order as the ray buffer, one intersection per ray. The intersection data type is defined by the intersectionDataType and intersectionStride properties. @param intersectionBufferOffset Offset, in bytes, into the intersection buffer. Must be a multiple of the intersection stride. @param rayIndexCount Number of ray indices @param accelerationStructure Acceleration structure to test against

func (*MPSRayIntersector) EncodeIntersectionToCommandBufferIntersectionTypeRayBufferRayBufferOffsetRayIndexBufferRayIndexBufferOffsetIntersectionBufferIntersectionBufferOffsetRayIndexCountBufferRayIndexCountBufferOffsetAccelerationStructure ¶

func (o *MPSRayIntersector) EncodeIntersectionToCommandBufferIntersectionTypeRayBufferRayBufferOffsetRayIndexBufferRayIndexBufferOffsetIntersectionBufferIntersectionBufferOffsetRayIndexCountBufferRayIndexCountBufferOffsetAccelerationStructure(commandBuffer metal.MTLCommandBuffer, intersectionType MPSIntersectionType, rayBuffer metal.MTLBuffer, rayBufferOffset uint, rayIndexBuffer metal.MTLBuffer, rayIndexBufferOffset uint, intersectionBuffer metal.MTLBuffer, intersectionBufferOffset uint, rayIndexCountBuffer metal.MTLBuffer, rayIndexCountBufferOffset uint, accelerationStructure *MPSAccelerationStructure)

@brief Schedule intersection tests between rays and an acceleration structure with a ray count provided in a buffer @param commandBuffer Command buffer to schedule intersection testing in @param intersectionType Which type of intersection to test for @param rayBuffer Buffer containing rays to intersect against the acceleration structure. The ray data type is defined by the rayDataType and rayStride properties. @param rayBufferOffset Offset, in bytes, into the ray buffer. Must be a multiple of the ray stride. @param rayIndexBuffer Buffer containing ray indices. Each index references a ray in the ray buffer. The ray index data type is controlled by the rayIndexDataType property. @param rayIndexBufferOffset Offset, in bytes, into the ray index buffer. Must be a multiple of the stride of the ray index type. @param intersectionBuffer Buffer to store intersection in. Intersections are stored in the same order as the ray buffer, one intersection per ray. The intersection data type is defined by the intersectionDataType and intersectionStride properties. @param intersectionBufferOffset Offset, in bytes, into the intersection buffer. Must be a multiple of the intersection stride. @param rayIndexCountBuffer Buffer containing number of rays as a 32 bit unsigned integer @param rayIndexCountBufferOffset Offset, in bytes, into the ray count buffer. Must be a multiple of 4 bytes. @param accelerationStructure Acceleration structure to test against

func (*MPSRayIntersector) EncodeIntersectionToCommandBufferIntersectionTypeRayTextureIntersectionTextureAccelerationStructure ¶

func (o *MPSRayIntersector) EncodeIntersectionToCommandBufferIntersectionTypeRayTextureIntersectionTextureAccelerationStructure(commandBuffer metal.MTLCommandBuffer, intersectionType MPSIntersectionType, rayTexture metal.MTLTexture, intersectionTexture metal.MTLTexture, accelerationStructure *MPSAccelerationStructure)

@brief Schedule intersection tests between rays and an acceleration structure, where rays and loaded from a texture and intersections are stored into a texture. This is convenient for hybrid rendering applications which produce ray data from a fragment shader. The ray and intersection texture must be 2D array textures. Ray data must be packed into consecutive channels and slices of the ray texture. Intersection data will be packed the same way. The ray and intersection data types are defined by the rayDataType and intersectionDataType properties. The rayStride and intersectionStride properties are ignored. Channels and slices beyond the required number are ignored when reading from the ray texture. Channels and slices beyond the required number are undefined when writing to the intersection texture. For example, if the ray data type is MPSRayDataTypeOriginMaskDirectionMaxDistance, the ray texture must have pixel format MTLPixelFormatRGBA32Float and at least two array slices, packed as follows: @code tex.write(float4(ray.position, as_type<float>(ray.mask)), pixel, 0); // slice 0 tex.write(float4(ray.direction, ray.maxDistance), pixel, 1); // slice 1 @end If the intersection data type is MPSIntersectionDataTypeDistance, the intersection texture may have pixel format MTLPixelFormatR32Float with just a single channel and one array slice, and should be unpacked as follows: @code float distance = tex.read(pixel, 0).x; @end On the other hand, if the intersection data type is MPSIntersectionDistancePrimitiveIndexInstanceIndexCoordinates, the intersection texture must have pixel format MTLPixelFormatRGBA32Float and at least two slices: @code float3 f0 = tex.read(pixel, 0); float distance = f0.x; unsigned int primitiveIndex = as_type<unsigned int>(f0.y); unsigned int instanceIndex = as_type<unsigned int>(f0.z); // w component is padding for this intersection data type float2 coordinates = tex.read(pixel, 1).xy; @end @param commandBuffer Command buffer to schedule intersection testing in @param intersectionType Which type of intersection to test for @param rayTexture A 2D array texture containing rays to intersect against the acceleration structure. The ray data type is defined by the rayDataType property. @param intersectionTexture Texture to store intersection in. Intersections are stored in the same position as the ray texture, one intersection per ray. The intersection data type is defined by the intersectionDataType property. @param accelerationStructure Acceleration structure to test against

func (*MPSRayIntersector) EncodeWithCoder ¶

func (o *MPSRayIntersector) EncodeWithCoder(coder *foundation.NSCoder)

func (*MPSRayIntersector) FrontFacingWinding ¶

func (o *MPSRayIntersector) FrontFacingWinding() metal.MTLWinding

@brief Winding order used to determine which direction a triangle or quadrilateral's normal points when back face or front face culling is enabled. Defaults to MTLWindingClockwise. @discussion If the front face winding is set to MTLWindingClockwise, the triangle or quadrilateral normal is considered to point towards the direction where the vertices are in clockwise order when viewed from that direction. Otherwise, if the front facing winding is set to MTLWindingCounterClockwise, the triangle or quadrilateral normal is considered to point in the opposite direction.

func (*MPSRayIntersector) InitWithCoderDevice ¶

func (o *MPSRayIntersector) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSRayIntersector

@brief Initialize the raytracer with an NSCoder and a Metal device

func (*MPSRayIntersector) InitWithDevice ¶

func (o *MPSRayIntersector) InitWithDevice(device metal.MTLDevice) *MPSRayIntersector

@brief Initialize the raytracer with a Metal device

func (*MPSRayIntersector) IntersectionDataType ¶

func (o *MPSRayIntersector) IntersectionDataType() MPSIntersectionDataType

@brief Intersection data type. Defaults to MPSIntersectionDataTypeDistancePrimitiveIndexCoordinates.

func (*MPSRayIntersector) IntersectionStride ¶

func (o *MPSRayIntersector) IntersectionStride() uint

@brief Offset, in bytes, between consecutive intersections in the intersection buffer. Defaults to 0, indicating that the intersections are packed according to their natural aligned size. @discussion This can be used to skip past any additional per-intersection that which may be stored alongside the MPSRayIntersection struct such as the surface normal at the point of intersection. Must be aligned to the alignment of the intersection data type.

func (*MPSRayIntersector) RayDataType ¶

func (o *MPSRayIntersector) RayDataType() MPSRayDataType

@brief Ray data type. Defaults to MPSRayDataTypeOriginDirection.

func (*MPSRayIntersector) RayIndexDataType ¶

func (o *MPSRayIntersector) RayIndexDataType() mpscore.MPSDataType

@brief Ray index data type. Defaults to MPSDataTypeUInt32. Only MPSDataTypeUInt16 and MPSDataTypeUInt32 are supported.

func (*MPSRayIntersector) RayMask ¶

func (o *MPSRayIntersector) RayMask() uint

@brief Global ray mask. Defaults to 0xFFFFFFFF. This value will be logically AND-ed with the per-ray mask if the ray data type contains a mask.

func (*MPSRayIntersector) RayMaskOperator ¶

func (o *MPSRayIntersector) RayMaskOperator() MPSRayMaskOperator

@brief The operator to apply to determine whether to accept an intersection between a ray and a primitive or instance. Defaults to MPSRayMaskOperatorAnd.

func (*MPSRayIntersector) RayMaskOptions ¶

func (o *MPSRayIntersector) RayMaskOptions() MPSRayMaskOptions

@brief Whether to enable primitive and instance masks. Defaults to MPSRayMaskOptionNone. @discussion If MPSRayMaskOptionPrimitive or MPSRayMaskOptionInstance is enabled, each ray and primitive and/or instance is associated with a 32 bit unsigned integer mask. Before checking for intersection between a ray and a primitive or instance, the corresponding masks are compared using the ray mask operator defined by the rayMaskOperator property. If the result is zero, the intersection is skipped. This can be used to make certain primitives or instances invisible to certain rays. For example, objects can be grouped into layers and their visibility can be toggled by modifying the ray masks rather than removing the objects from the scene and rebuilding the acceleration structure. Alternatively, certain objects can be prevented from casting shadows by making them invisible to shadow rays. Enabling this option may reduce raytracing performance.

func (*MPSRayIntersector) RayStride ¶

func (o *MPSRayIntersector) RayStride() uint

@brief Offset, in bytes, between consecutive rays in the ray buffer. Defaults to 0, indicating that the rays are packed according to their natural aligned size. @discussion This can be used to skip past any additional per-ray data that may be stored alongside the MPSRay struct such as the current radiance along the ray or the source pixel coordinates. Must be aligned to the alignment of the ray data type.

func (*MPSRayIntersector) RecommendedMinimumRayBatchSizeForRayCount ¶

func (o *MPSRayIntersector) RecommendedMinimumRayBatchSizeForRayCount(rayCount uint) uint

@brief Get the recommended minimum number of rays to submit for intersection in one batch @discussion In order to keep the system responsive, and to limit the amount of memory allocated to ray and intersection buffers, it may be desirable to divide the rays to be intersected against an acceleration structure into smaller batches. However, submitting too few rays in a batch reduces GPU utilization and performance. This method provides a recommended minimum number of rays to submit in any given batch. For example, for a 1920x1080 image, this method may recommend that the image be divided into 512x512 tiles. The actual recommendation varies per device and total ray count. @param rayCount The total number of rays to be submitted @return The recommended minimum ray batch size

func (*MPSRayIntersector) SetBoundingBoxIntersectionTestType ¶

func (o *MPSRayIntersector) SetBoundingBoxIntersectionTestType(boundingBoxIntersectionTestType MPSBoundingBoxIntersectionTestType)

func (*MPSRayIntersector) SetCullMode ¶

func (o *MPSRayIntersector) SetCullMode(cullMode metal.MTLCullMode)

func (*MPSRayIntersector) SetFrontFacingWinding ¶

func (o *MPSRayIntersector) SetFrontFacingWinding(frontFacingWinding metal.MTLWinding)

func (*MPSRayIntersector) SetIntersectionDataType ¶

func (o *MPSRayIntersector) SetIntersectionDataType(intersectionDataType MPSIntersectionDataType)

func (*MPSRayIntersector) SetIntersectionStride ¶

func (o *MPSRayIntersector) SetIntersectionStride(intersectionStride uint)

func (*MPSRayIntersector) SetRayDataType ¶

func (o *MPSRayIntersector) SetRayDataType(rayDataType MPSRayDataType)

func (*MPSRayIntersector) SetRayIndexDataType ¶

func (o *MPSRayIntersector) SetRayIndexDataType(rayIndexDataType mpscore.MPSDataType)

func (*MPSRayIntersector) SetRayMask ¶

func (o *MPSRayIntersector) SetRayMask(rayMask uint)

func (*MPSRayIntersector) SetRayMaskOperator ¶

func (o *MPSRayIntersector) SetRayMaskOperator(rayMaskOperator MPSRayMaskOperator)

func (*MPSRayIntersector) SetRayMaskOptions ¶

func (o *MPSRayIntersector) SetRayMaskOptions(rayMaskOptions MPSRayMaskOptions)

func (*MPSRayIntersector) SetRayStride ¶

func (o *MPSRayIntersector) SetRayStride(rayStride uint)

func (*MPSRayIntersector) SetTriangleIntersectionTestType ¶

func (o *MPSRayIntersector) SetTriangleIntersectionTestType(triangleIntersectionTestType MPSTriangleIntersectionTestType)

func (*MPSRayIntersector) TriangleIntersectionTestType ¶

func (o *MPSRayIntersector) TriangleIntersectionTestType() MPSTriangleIntersectionTestType

@brief Ray/triangle intersection test type. Defaults to MPSTriangleIntersectionTestTypeDefault. Quads are broken into two triangles for intersection testing, so this property also applies to quadrilateral intersections.

func (MPSRayMaskOperator) String ¶

func (e MPSRayMaskOperator) String() string

func (MPSRayMaskOptions) String ¶

func (e MPSRayMaskOptions) String() string

func (*MPSSVGF) BilateralFilterRadius ¶

func (o *MPSSVGF) BilateralFilterRadius() uint

@brief The radius of the bilateral filter. Defaults to 2 resulting in a 5x5 filter.

func (*MPSSVGF) BilateralFilterSigma ¶

func (o *MPSSVGF) BilateralFilterSigma() float32

@brief The sigma value of the Gaussian function used by the bilateral filter. Must be greater than zero. Defaults to 1.2.

func (*MPSSVGF) ChannelCount ¶

func (o *MPSSVGF) ChannelCount() uint

@brief The number of channels to filter in the source image. Must be at least one and at most three. Defaults to 3.

func (*MPSSVGF) ChannelCount2 ¶

func (o *MPSSVGF) ChannelCount2() uint

@brief The number of channels to filter in the second source image. Must be at least one and at most three. Defaults to 3.

func (*MPSSVGF) DepthWeight ¶

func (o *MPSSVGF) DepthWeight() float32

@brief Controls how samples' depths are compared during reprojection, variance estimation, and bilateral filtering. The final weight is given by exp(-abs(Z1 - Z2) / depthWeight). Must be greater than zero. Defaults to 1.0.

func (*MPSSVGF) EncodeBilateralFilterToCommandBufferStepDistanceSourceTextureDestinationTextureDepthNormalTexture ¶

func (o *MPSSVGF) EncodeBilateralFilterToCommandBufferStepDistanceSourceTextureDestinationTextureDepthNormalTexture(commandBuffer metal.MTLCommandBuffer, stepDistance uint, sourceTexture metal.MTLTexture, destinationTexture metal.MTLTexture, depthNormalTexture metal.MTLTexture)

@brief Encode bilateral filter into a command buffer @discussion Performs an edge avoiding blur with radius given by the bilateraFilterRadius property with sampling weighted by a Gaussian filter with sigma given by the bilteralFilterSigma property. Normal and depth values from neighboring pixels will be compared with depth and normal values of the center pixel to determine if they are similar enough to include in the blur. These values are weighted by the depthWeight, normalWeight, and luminanceWeight properties. Before the variance values are used for luminance weighting, the variance is prefiltered with a small Gaussian blur with radius given by the variancePrefilterRadius property and sigma given by the variancePrefilterSigma property. This kernel should be run multiple times with a step distance of pow(2, i), starting with i = 0. It is recommended that the output of the first iteration be used as the image to be reprojected in the next frame. Then several more iterations should be run to compute the denoised image for the current frame. 5 total iterations is reasonable. The bilateral filter can operate on two sets of source and destination textures simultaneously to share costs such as loading depth and normal values from memory, computing various weights, etc. The second set of textures may be nil. The two images are assumed to share the same normal and depth values. The number of channels to filter in the source image(s) are given by the channelCount and channelCount2 properties. Furthermore, the luminance variance is packed into the final channel of the source image(s) to reduce the number of texture sample instructions required. The filtered color and variance values are packed the same way in the destination image(s). Therefore, the source and destination images must have at least channelCount + 1 and channelCount2 + 1 channels. Channels beyond the required number are ignored when reading from source images and set to zero when writing to destination images. The source image should be produced by either the variance estimation kernel or a previous iteration of the bilateral filter. The depth/normal texture must contain the depth and normal values for directly visible geometry for the current frame for each pixel. These values are packed into a four channel texture to reduce the number of texture sampling instructions required to load them. The first channel must store the depth value from zero to infinity. The normals must be stored in the last three channels as the three signed X, Y, and z components each between negative one and one. @param commandBuffer Command buffer to encode into @param stepDistance Number of pixels to skip between samples @param sourceTexture Source packed color and variance texture @param destinationTexture Destination packed color and variance texture @param depthNormalTexture The depth and normal values for the current frame

func (*MPSSVGF) EncodeBilateralFilterToCommandBufferStepDistanceSourceTextureDestinationTextureSourceTexture2DestinationTexture2DepthNormalTexture ¶

func (o *MPSSVGF) EncodeBilateralFilterToCommandBufferStepDistanceSourceTextureDestinationTextureSourceTexture2DestinationTexture2DepthNormalTexture(commandBuffer metal.MTLCommandBuffer, stepDistance uint, sourceTexture metal.MTLTexture, destinationTexture metal.MTLTexture, sourceTexture2 metal.MTLTexture, destinationTexture2 metal.MTLTexture, depthNormalTexture metal.MTLTexture)

@brief Encode bilateral filter into a command buffer @discussion Performs an edge avoiding blur with radius given by the bilateraFilterRadius property with sampling weighted by a Gaussian filter with sigma given by the bilteralFilterSigma property. Normal and depth values from neighboring pixels will be compared with depth and normal values of the center pixel to determine if they are similar enough to include in the blur. These values are weighted by the depthWeight, normalWeight, and luminanceWeight properties. Before the variance values are used for luminance weighting, the variance is prefiltered with a small Gaussian blur with radius given by the variancePrefilterRadius property and sigma given by the variancePrefilterSigma property. This kernel should be run multiple times with a step distance of pow(2, i), starting with i = 0. It is recommended that the output of the first iteration be used as the image to be reprojected in the next frame. Then several more iterations should be run to compute the denoised image for the current frame. 5 total iterations is reasonable. The bilateral filter can operate on two sets of source and destination textures simultaneously to share costs such as loading depth and normal values from memory, computing various weights, etc. The second set of textures may be nil. The two images are assumed to share the same normal and depth values. The number of channels to filter in the source image(s) are given by the channelCount and channelCount2 properties. Furthermore, the luminance variance is packed into the final channel of the source image(s) to reduce the number of texture sample instructions required. The filtered color and variance values are packed the same way in the destination image(s). Therefore, the source and destination images must have at least channelCount + 1 and channelCount2 + 1 channels. Channels beyond the required number are ignored when reading from source images and set to zero when writing to destination images. The source image should be produced by either the variance estimation kernel or a previous iteration of the bilateral filter. The depth/normal texture must contain the depth and normal values for directly visible geometry for the current frame for each pixel. These values are packed into a four channel texture to reduce the number of texture sampling instructions required to load them. The first channel must store the depth value from zero to infinity. The normals must be stored in the last three channels as the three signed X, Y, and z components each between negative one and one. @param commandBuffer Command buffer to encode into @param stepDistance Number of pixels to skip between samples @param sourceTexture Source packed color and variance texture @param destinationTexture Destination packed color and variance texture @param sourceTexture2 Second source image @param destinationTexture2 Second destination image @param depthNormalTexture The depth and normal values for the current frame

func (*MPSSVGF) EncodeReprojectionToCommandBufferSourceTexturePreviousTextureDestinationTexturePreviousLuminanceMomentsTextureDestinationLuminanceMomentsTexturePreviousFrameCountTextureDestinationFrameCountTextureMotionVectorTextureDepthNormalTexturePreviousDepthNormalTexture ¶

func (o *MPSSVGF) EncodeReprojectionToCommandBufferSourceTexturePreviousTextureDestinationTexturePreviousLuminanceMomentsTextureDestinationLuminanceMomentsTexturePreviousFrameCountTextureDestinationFrameCountTextureMotionVectorTextureDepthNormalTexturePreviousDepthNormalTexture(commandBuffer metal.MTLCommandBuffer, sourceTexture metal.MTLTexture, previousTexture metal.MTLTexture, destinationTexture metal.MTLTexture, previousLuminanceMomentsTexture metal.MTLTexture, destinationLuminanceMomentsTexture metal.MTLTexture, previousFrameCountTexture metal.MTLTexture, destinationFrameCountTexture metal.MTLTexture, motionVectorTexture metal.MTLTexture, depthNormalTexture metal.MTLTexture, previousDepthNormalTexture metal.MTLTexture)

@brief Encode reprojection into a command buffer @discussion Normal and depth values from the previous frame will be compared with normal and depth values from the current frame to determine if they are similar enough to reproject into the current frame. These values are weighted by the depthWeight and normalWeight properties. If the combined weight exceeds the reprojectionThreshold property's value, the previous frame will be blended with the current frame according to the temporalWeighting and temporalReprojectionBlendFactor properties. The reprojection kernel can operate on two sets of source and destination textures simultaneously to share costs such as loading depth and normal values from memory, computing various weights, etc. The second set of textures may be nil. The two images are assumed to share the same depth and normal values. The number of channels in the source image(s), previous frame's image(s), and destination image(s) are given by the channelCount and channelCount2 properties. These images must have at least as many channels as given by these properties. Channels beyond the required number are ignored when reading from source images and set to zero when writing to the destination images, except the alpha channel which will be set to one if present. The previous frame's image will be ignored on the first frame. The source and destination luminance moments textures must be at least two-channel textures, which will be set to the accumulated first and second moments of luminance. Channels beyond the first two will be ignored when reading from the previous frame's texture and set to zero when writing to the destination texture. The previous frame's luminance moments will be ignored on the first frame. The frame count textures track the number of accumulated frames and must be at least R32Uint textures. The remaining channels will be ignored when reading from the source texture and set to zero when writing to the destination texture, if present. The previous frame count texture must be cleared to zero on the first frame or to reset the accumulated images to the current frame's image. The motion vector texture must be at least a two channel texture representing how many texels each texel in the source image(s) have moved since the previous frame. The remaining channels will be ignored if present. This texture may be nil, in which case the motion vector is assumed to be zero, which is suitable for static images. The depth/normal texture must contain the depth and normal values for directly visible geometry for the current frame for each pixel. These values are packed into a four channel texture to reduce the number of texture sampling instructions required to load them. The first channel must store the depth value from zero to infinity. The normals must be stored in the last three channels as the three signed X, Y, and z components each between negative one and one. The depth and normal values are not required if the motion vector texture is nil. The destination texture, destination luminance moments texture, and destination frame count texture are used by subsequent stages of the denoising filter. The destination frame count texture is also used as the source frame count texture the reprojection kernel in the next frame. @param commandBuffer Command buffer to encode into @param sourceTexture Current frame to denoise @param previousTexture Previous denoised frame to reproject into current frame @param destinationTexture Output blended image @param previousLuminanceMomentsTexture Previous accumulated luminance moments image @param destinationLuminanceMomentsTexture Output accumulated luminance moments image @param previousFrameCountTexture The number of frames accumulated in the previous source image @param destinationFrameCountTexture The number of frames accumulated in the destination texture(s) including the current frame @param motionVectorTexture Motion vector texture @param depthNormalTexture The depth and normal values for the current frame @param previousDepthNormalTexture The depth and normal values for the previous frame

func (*MPSSVGF) EncodeReprojectionToCommandBufferSourceTexturePreviousTextureDestinationTexturePreviousLuminanceMomentsTextureDestinationLuminanceMomentsTextureSourceTexture2PreviousTexture2DestinationTexture2PreviousLuminanceMomentsTexture2DestinationLuminanceMomentsTexture2PreviousFrameCountTextureDestinationFrameCountTextureMotionVectorTextureDepthNormalTexturePreviousDepthNormalTexture ¶

func (o *MPSSVGF) EncodeReprojectionToCommandBufferSourceTexturePreviousTextureDestinationTexturePreviousLuminanceMomentsTextureDestinationLuminanceMomentsTextureSourceTexture2PreviousTexture2DestinationTexture2PreviousLuminanceMomentsTexture2DestinationLuminanceMomentsTexture2PreviousFrameCountTextureDestinationFrameCountTextureMotionVectorTextureDepthNormalTexturePreviousDepthNormalTexture(commandBuffer metal.MTLCommandBuffer, sourceTexture metal.MTLTexture, previousTexture metal.MTLTexture, destinationTexture metal.MTLTexture, previousLuminanceMomentsTexture metal.MTLTexture, destinationLuminanceMomentsTexture metal.MTLTexture, sourceTexture2 metal.MTLTexture, previousTexture2 metal.MTLTexture, destinationTexture2 metal.MTLTexture, previousLuminanceMomentsTexture2 metal.MTLTexture, destinationLuminanceMomentsTexture2 metal.MTLTexture, previousFrameCountTexture metal.MTLTexture, destinationFrameCountTexture metal.MTLTexture, motionVectorTexture metal.MTLTexture, depthNormalTexture metal.MTLTexture, previousDepthNormalTexture metal.MTLTexture)

@brief Encode reprojection into a command buffer @discussion Normal and depth values from the previous frame will be compared with normal and depth values from the current frame to determine if they are similar enough to reproject into the current frame. These values are weighted by the depthWeight and normalWeight properties. If the combined weight exceeds the reprojectionThreshold property's value, the previous frame will be blended with the current frame according to the temporalWeighting and temporalReprojectionBlendFactor properties. The reprojection kernel can operate on two sets of source and destination textures simultaneously to share costs such as loading depth and normal values from memory, computing various weights, etc. The second set of textures may be nil. The two images are assumed to share the same depth and normal values. The number of channels in the source image(s), previous frame's image(s), and destination image(s) are given by the channelCount and channelCount2 properties. These images must have at least as many channels as given by these properties. Channels beyond the required number are ignored when reading from source images and set to zero when writing to the destination images, except the alpha channel which will be set to one if present. The previous frame's image will be ignored on the first frame. The source and destination luminance moments textures must be at least two-channel textures, which will be set to the accumulated first and second moments of luminance. Channels beyond the first two will be ignored when reading from the previous frame's texture and set to zero when writing to the destination texture. The previous frame's luminance moments will be ignored on the first frame. The frame count textures track the number of accumulated frames and must be at least R32Uint textures. The remaining channels will be ignored when reading from the source texture and set to zero when writing to the destination texture, if present. The previous frame count texture must be cleared to zero on the first frame or to reset the accumulated images to the current frame's image. The motion vector texture must be at least a two channel texture representing how many texels each texel in the source image(s) have moved since the previous frame. The remaining channels will be ignored if present. This texture may be nil, in which case the motion vector is assumed to be zero, which is suitable for static images. The depth/normal texture must contain the depth and normal values for directly visible geometry for the current frame for each pixel. These values are packed into a four channel texture to reduce the number of texture sampling instructions required to load them. The first channel must store the depth value from zero to infinity. The normals must be stored in the last three channels as the three signed X, Y, and z components each between negative one and one. The depth and normal values are not required if the motion vector texture is nil. The destination texture, destination luminance moments texture, and destination frame count texture are used by subsequent stages of the denoising filter. The destination frame count texture is also used as the source frame count texture the reprojection kernel in the next frame. @param commandBuffer Command buffer to encode into @param sourceTexture Current frame to denoise @param previousTexture Previous denoised frame to reproject into current frame @param destinationTexture Output blended image @param previousLuminanceMomentsTexture Previous accumulated luminance moments image @param destinationLuminanceMomentsTexture Output accumulated luminance moments image @param sourceTexture2 Second source image @param previousTexture2 Second previous image @param destinationTexture2 Second destination image @param previousLuminanceMomentsTexture2 Second previous luminance moments texture @param destinationLuminanceMomentsTexture2 Second destination luminance moments texture @param previousFrameCountTexture The number of frames accumulated in the previous source image @param destinationFrameCountTexture The number of frames accumulated in the destination texture(s) including the current frame @param motionVectorTexture Motion vector texture @param depthNormalTexture The depth and normal values for the current frame @param previousDepthNormalTexture The depth and normal values for the previous frame

func (*MPSSVGF) EncodeVarianceEstimationToCommandBufferSourceTextureLuminanceMomentsTextureDestinationTextureFrameCountTextureDepthNormalTexture ¶

func (o *MPSSVGF) EncodeVarianceEstimationToCommandBufferSourceTextureLuminanceMomentsTextureDestinationTextureFrameCountTextureDepthNormalTexture(commandBuffer metal.MTLCommandBuffer, sourceTexture metal.MTLTexture, luminanceMomentsTexture metal.MTLTexture, destinationTexture metal.MTLTexture, frameCountTexture metal.MTLTexture, depthNormalTexture metal.MTLTexture)

@brief Encode variance estimation into a command buffer @discussion Variance is computed from the accumulated first and second luminance moments. If the number of accumulated frames is below the minimumFramesForVarianceEstimation property, the luminance variance will be computed using a spatial estimate instead. The spatial estimate is computed using a bilateral filter with radius given by the varianceEstimationRadius property. Neighboring samples will be weighted according to a gaussian function with sigma given by the varianceEstimationSigma property. Normal and depth values from neighboring pixels will be compared with depth and normal values of the center pixel to determine if they are similar enough to include in the spatial blur. These values are weighted by the depthWeight and normalWeight properties. The variance kernel can operate on two sets of source and destination textures simultaneously to share costs such as loading depth and normal values from memory, computing various weights, etc. The second set of textures may be nil. The two images are assumed to share the same depth and normal values. The reprojected source texture, luminance moments texture and frame count texture are computed by the reprojection kernel. The computed variance will be stored in the last channel of the destination image, while the source image will be copied into the previous channels, to reduce the number of texture sample instructured required by the bilateral filter in the final stage of the denoising kernel. The number of channels in the source image(s) are given by the channelCount and channelCount2 properties. Therefore, the destination image(s) must have at least channelCount + 1 and channelCount2 + 1 channels and the source image(s) must have at least channelCount and channelCount2 channels. Channels beyond the required number are ignored when reading from source textures and set to zero when writing to destination textures. The depth/normal texture must contain the depth and normal values for directly visible geometry for the current frame for each pixel. These values are packed into a four channel texture to reduce the number of texture sampling instructions required to load them. The first channel must store the depth value from zero to infinity. The normals must be stored in the last three channels as the three signed X, Y, and z components each between negative one and one. If the minimumFramesForVarianceEstimation property is less than or equal to one, variance will be estimated directly from the accumulated luminance moments so the depth/normal texture may be nil. @param commandBuffer Command buffer to encode into @param sourceTexture Current reprojected frame to denoise @param luminanceMomentsTexture Luminance moments texture @param destinationTexture Output packed color and variance image @param frameCountTexture Number of frames accumulated into the source image @param depthNormalTexture The depth and normal values for the current frame

func (*MPSSVGF) EncodeVarianceEstimationToCommandBufferSourceTextureLuminanceMomentsTextureDestinationTextureSourceTexture2LuminanceMomentsTexture2DestinationTexture2FrameCountTextureDepthNormalTexture ¶

func (o *MPSSVGF) EncodeVarianceEstimationToCommandBufferSourceTextureLuminanceMomentsTextureDestinationTextureSourceTexture2LuminanceMomentsTexture2DestinationTexture2FrameCountTextureDepthNormalTexture(commandBuffer metal.MTLCommandBuffer, sourceTexture metal.MTLTexture, luminanceMomentsTexture metal.MTLTexture, destinationTexture metal.MTLTexture, sourceTexture2 metal.MTLTexture, luminanceMomentsTexture2 metal.MTLTexture, destinationTexture2 metal.MTLTexture, frameCountTexture metal.MTLTexture, depthNormalTexture metal.MTLTexture)

@brief Encode variance estimation into a command buffer @discussion Variance is computed from the accumulated first and second luminance moments. If the number of accumulated frames is below the minimumFramesForVarianceEstimation property, the luminance variance will be computed using a spatial estimate instead. The spatial estimate is computed using a bilateral filter with radius given by the varianceEstimationRadius property. Neighboring samples will be weighted according to a gaussian function with sigma given by the varianceEstimationSigma property. Normal and depth values from neighboring pixels will be compared with depth and normal values of the center pixel to determine if they are similar enough to include in the spatial blur. These values are weighted by the depthWeight and normalWeight properties. The variance kernel can operate on two sets of source and destination textures simultaneously to share costs such as loading depth and normal values from memory, computing various weights, etc. The second set of textures may be nil. The two images are assumed to share the same depth and normal values. The reprojected source texture, luminance moments texture and frame count texture are computed by the reprojection kernel. The computed variance will be stored in the last channel of the destination image, while the source image will be copied into the previous channels, to reduce the number of texture sample instructured required by the bilateral filter in the final stage of the denoising kernel. The number of channels in the source image(s) are given by the channelCount and channelCount2 properties. Therefore, the destination image(s) must have at least channelCount + 1 and channelCount2 + 1 channels and the source image(s) must have at least channelCount and channelCount2 channels. Channels beyond the required number are ignored when reading from source textures and set to zero when writing to destination textures. The depth/normal texture must contain the depth and normal values for directly visible geometry for the current frame for each pixel. These values are packed into a four channel texture to reduce the number of texture sampling instructions required to load them. The first channel must store the depth value from zero to infinity. The normals must be stored in the last three channels as the three signed X, Y, and z components each between negative one and one. If the minimumFramesForVarianceEstimation property is less than or equal to one, variance will be estimated directly from the accumulated luminance moments so the depth/normal texture may be nil. @param commandBuffer Command buffer to encode into @param sourceTexture Current reprojected frame to denoise @param luminanceMomentsTexture Luminance moments texture @param destinationTexture Output packed color and variance image @param sourceTexture2 Second source image @param luminanceMomentsTexture2 Second luminance moments image @param destinationTexture2 Second destination image @param frameCountTexture Number of frames accumulated into the source image @param depthNormalTexture The depth and normal values for the current frame

func (*MPSSVGF) EncodeWithCoder ¶

func (o *MPSSVGF) EncodeWithCoder(coder *foundation.NSCoder)

func (*MPSSVGF) InitWithCoderDevice ¶

func (o *MPSSVGF) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSSVGF

func (*MPSSVGF) InitWithDevice ¶

func (o *MPSSVGF) InitWithDevice(device metal.MTLDevice) *MPSSVGF

func (*MPSSVGF) LuminanceWeight ¶

func (o *MPSSVGF) LuminanceWeight() float32

@brief Controls how samples' luminance values are compared during bilateral filtering. The final weight is given by exp(-abs(L1 - L2) / (luminanceWeight * luminanceVariance + EPSILON)). Must be greater than or equal to zero. Defaults to 4.

func (*MPSSVGF) MinimumFramesForVarianceEstimation ¶

func (o *MPSSVGF) MinimumFramesForVarianceEstimation() uint

@brief The minimum number of frames which must be accumulated before variance can be computed directly from the accumulated luminance moments. If enough frames have not been accumulated, variance will be estimated with a spatial filter instead. Defaults to 4.

func (*MPSSVGF) NormalWeight ¶

func (o *MPSSVGF) NormalWeight() float32

@brief Controls how samples' normals are compared during reprojection, variance estimation, and bilateral filtering. The final weight is given by pow(max(dot(N1, N2)), normalWeight). Must be greater than or equal to zero. Defaults to 128.

func (*MPSSVGF) ReprojectionThreshold ¶

func (o *MPSSVGF) ReprojectionThreshold() float32

@brief During reprojection, minimum combined depth and normal weight needed to consider a pixel from the previous frame consistent with a pixel from the current frame. Must be greater than or equal to zero. Defaults to 0.01.

func (*MPSSVGF) SetBilateralFilterRadius ¶

func (o *MPSSVGF) SetBilateralFilterRadius(bilateralFilterRadius uint)

func (*MPSSVGF) SetBilateralFilterSigma ¶

func (o *MPSSVGF) SetBilateralFilterSigma(bilateralFilterSigma float32)

func (*MPSSVGF) SetChannelCount ¶

func (o *MPSSVGF) SetChannelCount(channelCount uint)

func (*MPSSVGF) SetChannelCount2 ¶

func (o *MPSSVGF) SetChannelCount2(channelCount2 uint)

func (*MPSSVGF) SetDepthWeight ¶

func (o *MPSSVGF) SetDepthWeight(depthWeight float32)

func (*MPSSVGF) SetLuminanceWeight ¶

func (o *MPSSVGF) SetLuminanceWeight(luminanceWeight float32)

func (*MPSSVGF) SetMinimumFramesForVarianceEstimation ¶

func (o *MPSSVGF) SetMinimumFramesForVarianceEstimation(minimumFramesForVarianceEstimation uint)

func (*MPSSVGF) SetNormalWeight ¶

func (o *MPSSVGF) SetNormalWeight(normalWeight float32)

func (*MPSSVGF) SetReprojectionThreshold ¶

func (o *MPSSVGF) SetReprojectionThreshold(reprojectionThreshold float32)

func (*MPSSVGF) SetTemporalReprojectionBlendFactor ¶

func (o *MPSSVGF) SetTemporalReprojectionBlendFactor(temporalReprojectionBlendFactor float32)

func (*MPSSVGF) SetTemporalWeighting ¶

func (o *MPSSVGF) SetTemporalWeighting(temporalWeighting MPSTemporalWeighting)

func (*MPSSVGF) SetVarianceEstimationRadius ¶

func (o *MPSSVGF) SetVarianceEstimationRadius(varianceEstimationRadius uint)

func (*MPSSVGF) SetVarianceEstimationSigma ¶

func (o *MPSSVGF) SetVarianceEstimationSigma(varianceEstimationSigma float32)

func (*MPSSVGF) SetVariancePrefilterRadius ¶

func (o *MPSSVGF) SetVariancePrefilterRadius(variancePrefilterRadius uint)

func (*MPSSVGF) SetVariancePrefilterSigma ¶

func (o *MPSSVGF) SetVariancePrefilterSigma(variancePrefilterSigma float32)

func (*MPSSVGF) TemporalReprojectionBlendFactor ¶

func (o *MPSSVGF) TemporalReprojectionBlendFactor() float32

@brief When using MPSTemporalWeightingExponentialMovingAverage, how much to blend the current frame with the previous frame during reprojection. The final value is given by current * temporalReprojectionBlendFactor + previous * (1 - temporalReprojectionBlendFactor). Must be between zero and one, inclusive. Defaults to 0.2.

func (*MPSSVGF) TemporalWeighting ¶

func (o *MPSSVGF) TemporalWeighting() MPSTemporalWeighting

@brief How to weight samples during temporal reprojection. Defaults to MPSTemporalWeightingAverage.

func (*MPSSVGF) VarianceEstimationRadius ¶

func (o *MPSSVGF) VarianceEstimationRadius() uint

@brief The radius of the spatial filter used when not enough frames have been accumulated to compute variance from accumulated luminance moments. Defaults to 3 resulting in a 7x7 filter.

func (*MPSSVGF) VarianceEstimationSigma ¶

func (o *MPSSVGF) VarianceEstimationSigma() float32

@brief The sigma value of the Gaussian function used by the spatial filter used when not enough frames have been accumulated to compute variance from accumulated luminance moments. Must be greater than zero. Defaults to 2.0.

func (*MPSSVGF) VariancePrefilterRadius ¶

func (o *MPSSVGF) VariancePrefilterRadius() uint

@brief The radius of the variance pre-filter of the bilateral filter. Defaults to 1 resulting in a 3x3 filter.

func (*MPSSVGF) VariancePrefilterSigma ¶

func (o *MPSSVGF) VariancePrefilterSigma() float32

@brief The sigma value of the Gaussian function used by the variance pre-filter of the bilateral filter. Must be greater than zero. Defaults to 1.33.

func (*MPSSVGFDefaultTextureAllocator) AllocatedTextureCount ¶

func (o *MPSSVGFDefaultTextureAllocator) AllocatedTextureCount() uint

@brief The number of textures which have been allocated from this allocator

func (*MPSSVGFDefaultTextureAllocator) Device ¶

func (o *MPSSVGFDefaultTextureAllocator) Device() metal.MTLDevice

@brief Metal device this object was allocated from

func (*MPSSVGFDefaultTextureAllocator) InitWithDevice ¶

func (o *MPSSVGFDefaultTextureAllocator) InitWithDevice(device metal.MTLDevice) *MPSSVGFDefaultTextureAllocator

@brief Initialize the MPSSVGFDefaultTextureAllocator with a Metal device

func (*MPSSVGFDefaultTextureAllocator) Reset ¶

func (o *MPSSVGFDefaultTextureAllocator) Reset()

@brief Remove all textures from the cache

func (*MPSSVGFDefaultTextureAllocator) ReturnTexture ¶

func (o *MPSSVGFDefaultTextureAllocator) ReturnTexture(texture metal.MTLTexture)

func (*MPSSVGFDefaultTextureAllocator) TextureWithPixelFormatWidthHeight ¶

func (o *MPSSVGFDefaultTextureAllocator) TextureWithPixelFormatWidthHeight(pixelFormat metal.MTLPixelFormat, width uint, height uint) metal.MTLTexture

func (*MPSSVGFDenoiser) BilateralFilterIterations ¶

func (o *MPSSVGFDenoiser) BilateralFilterIterations() uint

@brief The number of bilateral filter iterations to run. More iterations will improve quality at the cost of performance. Defaults to 5. Must be at least 1.

func (*MPSSVGFDenoiser) ClearTemporalHistory ¶

func (o *MPSSVGFDenoiser) ClearTemporalHistory()

@brief Clear the temporal history. Reprojection and temporal accumulation will restart on the next call to encodeToCommandBuffer:

func (*MPSSVGFDenoiser) EncodeToCommandBufferSourceTextureDestinationTextureSourceTexture2DestinationTexture2MotionVectorTextureDepthNormalTexturePreviousDepthNormalTexture ¶

func (o *MPSSVGFDenoiser) EncodeToCommandBufferSourceTextureDestinationTextureSourceTexture2DestinationTexture2MotionVectorTextureDepthNormalTexturePreviousDepthNormalTexture(commandBuffer metal.MTLCommandBuffer, sourceTexture metal.MTLTexture, destinationTexture metal.MTLTexture, sourceTexture2 metal.MTLTexture, destinationTexture2 metal.MTLTexture, motionVectorTexture metal.MTLTexture, depthNormalTexture metal.MTLTexture, previousDepthNormalTexture metal.MTLTexture)

@brief Encode denoising kernels to a command buffer @discussion Simultaneously removes noise from the source texture and optional second source texture, using the additional data in the motion vector, depth/normal, and previous depth/normal textures. Returns the result through the destination texture pointers. The depth/normal texture should be provided as the previous depth/normal texture for the next call to this method. This method will also update an internally managed temporal history to aid the denoising process. To reset this history, call the clearTemporalHistory method. This method will allocate and return several textures from and to the texture allocator the MPSSVGFDenoiser was initialized with. The number of iterations of the bilateral filter is controlled by the bilateralFilterIterations property. Larger numbers of iterations will improve the quality but reduce performance. To configure other parameters of the denoising process, modify the properties of the MPSSVGF object the MPSSVGFDenoiser was initialized with. @parameter commandBuffer Command buffer to encode into @parameter sourceTexture Source image to denoiser @parameter destinationTexture Denoised output image @parameter sourceTexture2 Optional second source image to denoise @parameter destinationTexture2 Denoised second output image, if there is a second source image @parameter motionVectorTexture Motion vector texture describing how much each texel has moved, in texels, since the previous frame. See the MPSSVGF object for more details. @parameter depthNormalTexture Texture containing linear depth in the X component and signed normals in the YZW components. See the MPSSVGF object for more details. @parameter previousDepthNormalTexture Depth/normal texture from the previous frame. See the MPSSVGF object for more details.

func (*MPSSVGFDenoiser) EncodeToCommandBufferSourceTextureMotionVectorTextureDepthNormalTexturePreviousDepthNormalTexture ¶

func (o *MPSSVGFDenoiser) EncodeToCommandBufferSourceTextureMotionVectorTextureDepthNormalTexturePreviousDepthNormalTexture(commandBuffer metal.MTLCommandBuffer, sourceTexture metal.MTLTexture, motionVectorTexture metal.MTLTexture, depthNormalTexture metal.MTLTexture, previousDepthNormalTexture metal.MTLTexture) metal.MTLTexture

@brief Encode denoising kernels to a command buffer @discussion Removes noise from the source texture, using the additional data in the motion vector, depth/normal, and previous depth/normal textures. Returns the resulting texture. The depth/normal texture should be provided as the previous depth/normal texture for the next call to this method. This method will also update an internally managed temporal history to aid the denoising process. To reset this history, call the clearTemporalHistory method. This method will allocate and return several textures from and to the texture allocator the MPSSVGFDenoiser was initialized with. The number of iterations of the bilateral filter is controlled by the bilateralFilterIterations property. Larger numbers of iterations will improve the quality but reduce performance. To configure other parameters of the denoising process, modify the properties of the MPSSVGF object the MPSSVGFDenoiser was initialized with. @parameter commandBuffer Command buffer to encode into @parameter sourceTexture Source image to denoiser @parameter motionVectorTexture Motion vector texture describing how much each texel has moved, in texels, since the previous frame. See the MPSSVGF object for more details. @parameter depthNormalTexture Texture containing linear depth in the X component and signed normals in the YZW components. See the MPSSVGF object for more details. @parameter previousDepthNormalTexture Depth/normal texture from the previous frame. See the MPSSVGF object for more details.

func (*MPSSVGFDenoiser) InitWithDevice ¶

func (o *MPSSVGFDenoiser) InitWithDevice(device metal.MTLDevice) *MPSSVGFDenoiser

@brief Initialize the MPSSVGFDenoiser object @parameter device The Metal device to use for denoising

func (*MPSSVGFDenoiser) InitWithSVGFTextureAllocator ¶

func (o *MPSSVGFDenoiser) InitWithSVGFTextureAllocator(svgf *MPSSVGF, textureAllocator MPSSVGFTextureAllocator) *MPSSVGFDenoiser

@brief Initialize the MPSSVGFDenoiser object @parameter svgf MPSSVGF kernels to use for denoising. This object can be used to configure temporal reprojection, bilateral blur settings, etc. @parameter textureAllocator An object conforming to the MPSSVGFTextureAllocator protocol. This object will be used to allocate temporary intermediate and output textures. This can be a custom object or an instance of the MPSSVGFDefaultTextureAllocator class.

func (*MPSSVGFDenoiser) ReleaseTemporaryTextures ¶

func (o *MPSSVGFDenoiser) ReleaseTemporaryTextures()

@brief Return any temporary textures to the texture allocator. Also clears the temporal history. This should be called before resizing the source texture(s).

func (*MPSSVGFDenoiser) SetBilateralFilterIterations ¶

func (o *MPSSVGFDenoiser) SetBilateralFilterIterations(bilateralFilterIterations uint)

func (*MPSSVGFDenoiser) Svgf ¶

func (o *MPSSVGFDenoiser) Svgf() *MPSSVGF

@brief The underlying MPSSVGF kernels object which will be used for denoising. Use this object to customize the denoising process.

func (*MPSSVGFDenoiser) TextureAllocator ¶

func (o *MPSSVGFDenoiser) TextureAllocator() MPSSVGFTextureAllocator

@brief The object which will be used to allocate intermediate and output textures.

func (*MPSTemporalAA) BlendFactor ¶

func (o *MPSTemporalAA) BlendFactor() float32

@brief How much to blend the current frame with the previous frame during temporal antialiasing. The final value is given by current * blendFactor + previous * (1 - blendFactor). Must be between zero and one, inclusive. Defaults to 0.1.

func (*MPSTemporalAA) EncodeToCommandBufferSourceTexturePreviousTextureDestinationTextureMotionVectorTextureDepthTexture ¶

func (o *MPSTemporalAA) EncodeToCommandBufferSourceTexturePreviousTextureDestinationTextureMotionVectorTextureDepthTexture(commandBuffer metal.MTLCommandBuffer, sourceTexture metal.MTLTexture, previousTexture metal.MTLTexture, destinationTexture metal.MTLTexture, motionVectorTexture metal.MTLTexture, depthTexture metal.MTLTexture)

@brief Encode temporal antialiasing a command buffer @discussion The motion vector texture must be at least a two channel texture representing how many texels each texel in the source image(s) have moved since the previous frame. The remaining channels will be ignored if present. This texture may be nil, in which case the motion vector is assumed to be zero, which is suitable for static images. The depth texture must contain the depth values for directly visible geometry for the current frame for each pixel. The first channel must store the depth value from zero to infinity. The depth texture may be nil, but this will prevent motion vectors from being dilated and may introduce aliasing along silhouette edges. The destination texture should be used as the previous texture in the next frame. @param commandBuffer Command buffer to encode into @param sourceTexture Current frame to denoise @param previousTexture Previous denoised frame to reproject into current frame @param destinationTexture Output blended image @param motionVectorTexture Motion vector texture @param depthTexture The depth values for the current frame

func (*MPSTemporalAA) EncodeWithCoder ¶

func (o *MPSTemporalAA) EncodeWithCoder(coder *foundation.NSCoder)

func (*MPSTemporalAA) InitWithCoderDevice ¶

func (o *MPSTemporalAA) InitWithCoderDevice(aDecoder *foundation.NSCoder, device metal.MTLDevice) *MPSTemporalAA

func (*MPSTemporalAA) InitWithDevice ¶

func (o *MPSTemporalAA) InitWithDevice(device metal.MTLDevice) *MPSTemporalAA

func (*MPSTemporalAA) SetBlendFactor ¶

func (o *MPSTemporalAA) SetBlendFactor(blendFactor float32)

func (MPSTemporalWeighting) String ¶

func (e MPSTemporalWeighting) String() string

func (MPSTransformType) String ¶

func (e MPSTransformType) String() string

func (*MPSTriangleAccelerationStructure) SetTriangleCount ¶

func (o *MPSTriangleAccelerationStructure) SetTriangleCount(triangleCount uint)

func (*MPSTriangleAccelerationStructure) TriangleCount ¶

func (o *MPSTriangleAccelerationStructure) TriangleCount() uint

@brief Number of triangles. Changes to this property require rebuilding the acceleration structure. Note that this property is an alias for the polygonCount property.

func (MPSTriangleIntersectionTestType) String ¶

func (e MPSTriangleIntersectionTestType) String() string

func (Mach_vm_range_flags_t) String ¶

func (e Mach_vm_range_flags_t) String() string

func (Mach_vm_range_flavor_t) String ¶

func (e Mach_vm_range_flavor_t) String() string

func (Mach_vm_range_tag_t) String ¶

func (e Mach_vm_range_tag_t) String() string

func (Mpo_flags_t) String ¶

func (e Mpo_flags_t) String() string

func (Os_clockid_t) String ¶

func (e Os_clockid_t) String() string

func (Ptrauth_key) String ¶

func (e Ptrauth_key) String() string

func (Qos_class_t) String ¶

func (e Qos_class_t) String() string

func (Virtual_memory_guard_exception_code_t) String ¶

func (e Virtual_memory_guard_exception_code_t) String() string

func (Xpc_listener_create_flags_t) String ¶

func (e Xpc_listener_create_flags_t) String() string

func (Xpc_session_create_flags_t) String ¶

func (e Xpc_session_create_flags_t) String() string