---
title: CanaryDescription
framework: realitykit
role: symbol
role_heading: Class
path: realitykit/canarydescription
---

# CanaryDescription

## Declaration

```swift
class CanaryDescription
```

## Topics

### Creating a description

- [init(multipliers:options:modulus:moduloOffset:)](realitykit/canarydescription/init(multipliers:options:modulus:modulooffset:).md)

### Configuring deformation

- [multipliers](realitykit/canarydescription/multipliers.md)
- [options](realitykit/canarydescription/options.md)
- [modulus](realitykit/canarydescription/modulus.md)
- [moduloOffset](realitykit/canarydescription/modulooffset.md)
- [sparse](realitykit/canarydescription/sparse.md)

### Querying semantic options

- [deforms()](realitykit/canarydescription/deforms().md)
- [requires()](realitykit/canarydescription/requires().md)

### Identifying the description

- [name()](realitykit/canarydescription/name().md)

## See Also

### Low-level deformation

- [LowLevelDeformation](realitykit/lowleveldeformation.md)
- [LowLevelDeformationContext](realitykit/lowleveldeformationcontext.md)