.TH "MPSInstanceAccelerationStructure" 3 "Mon Jul 9 2018" "Version MetalPerformanceShaders-119.3" "MetalPerformanceShaders.framework" \" -*- nroff -*-
.ad l
.nh
.SH NAME
MPSInstanceAccelerationStructure
.SH SYNOPSIS
.br
.PP
.PP
\fC#import <MPSInstanceAccelerationStructure\&.h>\fP
.PP
Inherits \fBMPSAccelerationStructure\fP\&.
.SS "Properties"

.in +1c
.ti -1c
.RI "NSArray< \fBMPSTriangleAccelerationStructure\fP * > *_Nullable \fBaccelerationStructures\fP"
.br
.RI "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 triangle acceleration structure is rebuilt or refit, the instance acceleration structure must subsequently be rebuilt or refit\&. "
.ti -1c
.RI "id< MTLBuffer > _Nullable \fBinstanceBuffer\fP"
.br
.RI "Buffer containing the 32 bit unsigned integer index into the acceleration structure array for each instance\&. "
.ti -1c
.RI "NSUInteger \fBinstanceBufferOffset\fP"
.br
.RI "Offset, in bytes, into the instance buffer\&. Defaults to 0 bytes\&. Must be aligned to 4 bytes\&. "
.ti -1c
.RI "id< MTLBuffer > _Nullable \fBtransformBuffer\fP"
.br
.RI "Buffer containing one column major matrix_float4x4 transformation matrix per instance\&. "
.ti -1c
.RI "NSUInteger \fBtransformBufferOffset\fP"
.br
.RI "Offset, in bytes, into the transform buffer\&. Defaults to 0 bytes\&. Must be aligned to the stride of the transform type\&. "
.ti -1c
.RI "MPSTransformType \fBtransformType\fP"
.br
.RI "Instance transform type\&. Defaults to MPSTransformTypeFloat4x4\&. Changes to this property require rebuilding the acceleration structure\&. "
.ti -1c
.RI "id< MTLBuffer > _Nullable \fBmaskBuffer\fP"
.br
.RI "Mask buffer containing one uint32_t mask per instance\&. May be nil\&. "
.ti -1c
.RI "NSUInteger \fBmaskBufferOffset\fP"
.br
.RI "Offset, in bytes, into the mask buffer\&. Defaults to 0 bytes\&. Must be aligned to 4 bytes\&. "
.ti -1c
.RI "NSUInteger \fBinstanceCount\fP"
.br
.RI "Number of instances\&. Changes to this property require rebuilding the acceleration structure\&. "
.in -1c
.SS "Additional Inherited Members"
.SH "Property Documentation"
.PP 
.SS "\- (NSArray<\fBMPSTriangleAccelerationStructure\fP *>* _Nullable) accelerationStructures\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [retain]\fP"

.PP
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 triangle acceleration structure is rebuilt or refit, the instance acceleration structure must subsequently be rebuilt or refit\&. 
.SS "\- (id<MTLBuffer> _Nullable) instanceBuffer\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [retain]\fP"

.PP
Buffer containing the 32 bit unsigned integer index into the acceleration structure array for each instance\&. 
.SS "\- (NSUInteger) instanceBufferOffset\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [assign]\fP"

.PP
Offset, in bytes, into the instance buffer\&. Defaults to 0 bytes\&. Must be aligned to 4 bytes\&. 
.SS "\- (NSUInteger) instanceCount\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [assign]\fP"

.PP
Number of instances\&. Changes to this property require rebuilding the acceleration structure\&. 
.SS "\- (id<MTLBuffer> _Nullable) maskBuffer\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [retain]\fP"

.PP
Mask buffer containing one uint32_t mask per instance\&. May be nil\&. 
.SS "\- (NSUInteger) maskBufferOffset\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [assign]\fP"

.PP
Offset, in bytes, into the mask buffer\&. Defaults to 0 bytes\&. Must be aligned to 4 bytes\&. 
.SS "\- (id<MTLBuffer> _Nullable) transformBuffer\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [retain]\fP"

.PP
Buffer containing one column major matrix_float4x4 transformation matrix per instance\&. 
.SS "\- (NSUInteger) transformBufferOffset\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [assign]\fP"

.PP
Offset, in bytes, into the transform buffer\&. Defaults to 0 bytes\&. Must be aligned to the stride of the transform type\&. 
.SS "\- (MPSTransformType) transformType\fC [read]\fP, \fC [write]\fP, \fC [nonatomic]\fP, \fC [assign]\fP"

.PP
Instance transform type\&. Defaults to MPSTransformTypeFloat4x4\&. Changes to this property require rebuilding the acceleration structure\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for MetalPerformanceShaders\&.framework from the source code\&.