---
title: canvasPixelAspectRatio()
framework: Professional Video Applications
role: symbol
role_heading: Instance Method
platforms: [fxplug 3.1+]
path: professional_video_applications/fxonscreencontrolapi_v2/canvaspixelaspectratio()
---

# canvasPixelAspectRatio()

Returns the pixel aspect ratio of the canvas.

## Declaration

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

## Return Value

Return Value The pixel aspect ratio of the canvas.

## Discussion

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.

## See Also

### Canvas Information

- [canvasZoom()](professional_video_applications/fxonscreencontrolapi_v2/canvaszoom().md)
- [pixelAspectRatio()](professional_video_applications/fxonscreencontrolapi_v2/pixelaspectratio().md)
- [objectBounds()](professional_video_applications/fxonscreencontrolapi_v2/objectbounds().md)
- [objectToScreenTransform()](professional_video_applications/fxonscreencontrolapi_v2/objecttoscreentransform().md)
