<!--
{
  "availability" : [
    "FxPlug: 3.1.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "professional_video_applications",
  "identifier" : "/documentation/professional_video_applications/FxOnScreenControlAPI_v2/canvasPixelAspectRatio()",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "Professional Video Applications"
    ],
    "preciseIdentifier" : "c:objc(pl)FxOnScreenControlAPI_v2(im)canvasPixelAspectRatio"
  },
  "title" : "canvasPixelAspectRatio()"
}
-->

# canvasPixelAspectRatio()

Returns the pixel aspect ratio of the canvas.

```
func canvasPixelAspectRatio() -> Double
```

## Return Value

The pixel aspect ratio of the canvas.

## Discussion

This can change if the user sets the canvas to be viewed with or without pixel aspect ratio correction, so do not cache this value.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)