Skip to main content

RenderOptions

Struct RenderOptions 

Source
pub struct RenderOptions {
    pub backend: BackendPreference,
    pub gpu: GpuRendererSettings,
    pub clear_sky: Rgb,
    pub gpu_mip_scan_dist: f32,
    pub gpu_chunk_upload_budget: u32,
    pub gpu_clip_upload_budget: u32,
    pub gpu_sprite_lod_px: f32,
    pub cpu_max_grid_vsid: u32,
    pub cpu_render_threads: usize,
}
Expand description

Construction-time options for SceneRenderer::new.

§Environment overrides (QE-C6)

Each GPU tuning knob below has a ROXLAP_* escape hatch, so a shipped binary can be re-tuned from the shell. All of them are read once, at SceneRenderer construction (never per frame), the env value wins over the programmatic one, and unparseable values are dropped with a log::warn!. On wasm there is no process environment and the field values apply as-is.

variableoverridesvalues
ROXLAP_GPU_POWERgpu.power_preferencelow / high
ROXLAP_GPU_SPRITE_LOD_PXgpu_sprite_lod_pxf32, screen px
ROXLAP_GPU_MIP_SCAN_DISTgpu_mip_scan_distf32, world units
ROXLAP_GPU_CHUNK_BUDGETgpu_chunk_upload_budgetu32, 0 = unbounded
ROXLAP_GPU_CLIP_BUDGETgpu_clip_upload_budgetu32, 0 = unbounded

Other ROXLAP_* variables you may have seen (ROXLAP_GPU, ROXLAP_SCENE, ROXLAP_CAPTURE, …) belong to the demo hosts, not the library — backend selection is backend, decided by your code.

Fields§

§backend: BackendPreference

Which backend to build (QE.7b — replaces want_gpu: bool; migrate want_gpu: trueBackendPreference::PreferGpu, falseBackendPreference::Cpu).

§gpu: GpuRendererSettings

Settings forwarded to roxlap_gpu::GpuRenderer when the GPU backend is selected.

§clear_sky: Rgb

Packed 0x00RRGGBB (alpha ignored) the empty/clear frame fills with until a scene render lands. Also the CPU sky-miss colour default if a frame supplies none.

§gpu_mip_scan_dist: f32

GPU scene-grid LOD scan distance in world units (GPU.11.1): rays farther than this from the camera sample coarser chunk mips. QE.2a — construction-time here (was a per-frame FrameParams field); the ROXLAP_GPU_MIP_SCAN_DIST env var still overrides it as a user-side escape hatch. Ignored by the CPU backend (its mip ladder comes from OpticastSettings::mip_scan_dist).

§gpu_chunk_upload_budget: u32

GPU per-frame dirty-chunk install budget (QE.2c — was env-only ROXLAP_GPU_CHUNK_BUDGET, which still overrides). Each chunk install issues several queue.write_buffer calls; a big batch can exhaust the device staging pool (seen as egui-wgpu panics on Mesa/NVK while flying fast). Small budget = bounded per-frame writes, more terrain pop-in when moving quickly. 0 = unbounded.

§gpu_clip_upload_budget: u32

GPU frames-per-staging-flush while registering a flipbook clip (QE.2c — was env-only ROXLAP_GPU_CLIP_BUDGET, which still overrides). 0 = unbounded.

§gpu_sprite_lod_px: f32

GPU sprite mip-LOD threshold (QE.8; ROXLAP_GPU_SPRITE_LOD_PX overrides): the pass steps to a coarser sprite mip once a mip-0 voxel would project smaller than this many screen pixels. 1.0 (the default) is the “don’t go sub-pixel” threshold and keeps GPU sprites visually identical to the CPU backend (which has no sprite LOD); raise it to trade sprite fidelity for distant-sprite speed (the pre-QE.8 behaviour was 4.0, which visibly densified thin/hollow translucent models at range).

§cpu_max_grid_vsid: u32
👎Deprecated since 0.22.0:

ignored — the DDA renderer replaced the strip-parallel opticast and needs no scratch-pool pre-sizing

Unused. Sized the strip-parallel opticast’s per-frame scratch pool; the per-pixel DDA renderer that replaced it needs no pre-sizing, so the value is ignored.

§cpu_render_threads: usize
👎Deprecated since 0.22.0:

ignored — the DDA renderer parallelises over the rayon pool; bound it with RAYON_NUM_THREADS

Unused. Set the strip-parallel opticast’s thread count; the DDA renderer parallelises internally over the rayon pool (bound it with RAYON_NUM_THREADS if needed), so the value is ignored.

Trait Implementations§

Source§

impl Clone for RenderOptions

Source§

fn clone(&self) -> RenderOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for RenderOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more