Struct RenderOptions 

pub struct RenderOptions { /* private fields */ }

Options for rendering radar radials.

Use the builder methods to configure rendering options, then pass to render_radials.

Example

use nexrad_render::RenderOptions;

// Render 800x800 with black background (default)
let options = RenderOptions::new(800, 800);

// Render with transparent background for compositing
let options = RenderOptions::new(800, 800).transparent();

// Render with custom background color (RGBA)
let options = RenderOptions::new(800, 800).with_background([255, 255, 255, 255]);

Implementations

impl RenderOptions

pub fn new(width: usize, height: usize) -> Self

Creates new render options with the specified dimensions and black background.

pub fn transparent(self) -> Self

Sets the background to transparent for compositing.

When rendering with a transparent background, areas without radar data will be fully transparent, allowing multiple renders to be layered.

pub fn with_background(self, rgba: [u8; 4]) -> Self

Sets a custom background color as RGBA bytes.

pub fn with_extent(self, extent: GeoExtent) -> Self

Sets a geographic extent for the rendered area.

When set, the image covers exactly this extent. This enables consistent spatial mapping for side-by-side comparison of multiple renders.

pub fn with_coord_system(self, coord_system: RadarCoordinateSystem) -> Self

Sets a radar coordinate system for geographic projection.

This enables geographic metadata in the RenderResult, including pixel-to-geo and geo-to-pixel coordinate conversions.

pub fn native_for(field: &SweepField) -> Self

Creates render options sized for native resolution of a sweep field.

Sets both width and height to gate_count * 2, which ensures approximately one pixel per gate at the outer edge of the sweep. This produces the highest fidelity rendering without wasting pixels.

pub fn with_interpolation(self, interpolation: Interpolation) -> Self

Sets the interpolation method for rendering.

Default is Interpolation::Nearest. Use Interpolation::Bilinear for smoother output that blends neighboring data gates.

pub fn bilinear(self) -> Self

Shorthand to enable bilinear interpolation.

Equivalent to .with_interpolation(Interpolation::Bilinear).

pub fn size(&self) -> (usize, usize)

Output image dimensions (width, height) in pixels.

pub fn background(&self) -> Option<[u8; 4]>

Background color as RGBA bytes. None means transparent (all zeros).

pub fn extent(&self) -> Option<&GeoExtent>

Geographic extent to render. If None, auto-computed from data range.

When set, the image covers exactly this extent, enabling consistent spatial mapping across multiple renders for side-by-side comparison.

pub fn coord_system(&self) -> Option<&RadarCoordinateSystem>

Radar coordinate system for geographic projection.

When provided, the RenderResult will include geographic metadata enabling pixel-to-geo and geo-to-pixel coordinate conversions.

pub fn interpolation(&self) -> Interpolation

Interpolation method for pixel sampling.

Default is Interpolation::Nearest. Use Interpolation::Bilinear for smoother output that blends neighboring data gates.

Trait Implementations

impl Clone for RenderOptions

fn clone(&self) -> RenderOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RenderOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.