SceneSettings.aspectRatio Property

Description

Gets and sets the aspect ratio of the rendered image. This is not the resolution, but only the aspect ratio. To define a custom aspect ratio set this property to CustomRenderAspectRatio and use the aspectRatioHeight and aspectRatioWidth properties to define any aspect ratio.

This is used for in-canvas render to allow you to use a different aspect ratio than what is implicitly defined by the size of the active viewport.

If this is set to CustomRenderAspectRatio, use the aspectRatioHeight and aspectRatioWidth to define the aspect ratio.

Syntax

# Get the value of the property.
propertyValue = sceneSettings_var.aspectRatio

# Set the value of the property.
sceneSettings_var.aspectRatio = propertyValue

#include <Fusion/Render/SceneSettings.h>

// Get the value of the property.
RenderAspectRatios propertyValue = sceneSettings_var->aspectRatio();

// Set the value of the property, where value_var is a RenderAspectRatios.
bool returnValue = sceneSettings_var->aspectRatio(value_var);

Property Value

Version