CameraSnapshot

class ansys.stk.core.graphics.CameraSnapshot

Takes snapshots of the 3D window.

Overview

Methods

save_to_file	Save a snapshot of the 3D window to the filename with the specified format.
save_to_file_with_width_and_dpi	Save a snapshot of the 3D window to the filename with the specified format at high resolution…
save_to_clipboard	Save a single frame of the 3D window to the clipboard.
save_to_raster	Save a snapshot of the 3D window to a raster.
save_to_texture	Save a snapshot of the 3D window to a texture 2d.

Import detail

from ansys.stk.core.graphics import CameraSnapshot

Method detail

CameraSnapshot.save_to_file(self, filename: str, camera_snapshot_format: SnapshotFileFormat) → None

Save a snapshot of the 3D window to the filename with the specified format.

Parameters:

filename : str

camera_snapshot_format : SnapshotFileFormat

Returns:

None

CameraSnapshot.save_to_file_with_width_and_dpi(self, filename: str, camera_snapshot_format: SnapshotFileFormat, width_in_inches: float, dots_per_inch: float) → None

Save a snapshot of the 3D window to the filename with the specified format at high resolution…

Parameters:

filename : str

camera_snapshot_format : SnapshotFileFormat

width_in_inches : float

dots_per_inch : float

Returns:

None

CameraSnapshot.save_to_clipboard(self) → None

Save a single frame of the 3D window to the clipboard.

Returns:

None

CameraSnapshot.save_to_raster(self) → IRaster

Save a snapshot of the 3D window to a raster.

Returns:

IRaster

CameraSnapshot.save_to_texture(self) → RendererTexture2D

Save a snapshot of the 3D window to a texture 2d.

Returns:

RendererTexture2D