Skip to main content

EffectComposer

Struct EffectComposer 

Source
pub struct EffectComposer {
    pub render_to_screen: bool,
    /* private fields */
}
Available on crate feature render only.
Expand description

three.js EffectComposer.

Two half-float buffers, writeBuffer and readBuffer; each enabled pass reads one and writes the other (or draws into readBuffer in place), the two swap after any pass that needs_swap, and the last enabled pass draws to the screen when render_to_screen is on. MaskPass / ClearMaskPass confine the passes between them to the mask, as three.js’s stencil test does.

Scenes and cameras are not stored: passes name them by index, and each frame’s render_frame is handed the lists those indices point into. render is the one-scene case.

let mut composer = EffectComposer::with_size(800, 600);
composer.add_pass(RenderPass::new());
composer.add_pass(UnrealBloomPass::new(800, 600, 1.5, 0.4, 0.85));
composer.add_pass(OutputPass::new());
composer.set_screen_format(threers::wgpu::TextureFormat::Bgra8Unorm);
composer.render(r, scene, camera, view);

Fields§

§render_to_screen: bool

three.js renderToScreen: the last enabled pass draws to the screen.

Implementations§

Source§

impl EffectComposer

Source

pub fn with_size(width: u32, height: u32) -> Self

A composer for a width × height drawing buffer (three.js takes the renderer’s size). Its buffers are allocated on the first render.

Source

pub fn new( _device: Arc<Device>, _queue: Arc<Queue>, width: u32, height: u32, format: TextureFormat, ) -> Self

with_size, with format the format of the views render will draw the last pass into. The device and queue are the renderer’s, which allocates the buffers.

Source

pub fn with_target(target: Target) -> Self

three.js new EffectComposer(renderer, renderTarget): chain through target (and a second target like it) rather than half-float buffers of the composer’s own.

Source

pub fn set_screen_format(&mut self, format: TextureFormat)

The format of the views render draws into.

Source

pub fn screen_format(&self) -> TextureFormat

Source

pub fn add_pass(&mut self, pass: impl Pass + 'static) -> &mut Self

three.js addPass: append, and size the pass to the composer.

Source

pub fn add_boxed(&mut self, pass: Box<dyn Pass>) -> &mut Self

add_pass for a pass already boxed.

Source

pub fn insert_boxed(&mut self, pass: Box<dyn Pass>, index: usize)

three.js insertPass.

Source

pub fn remove_pass(&mut self, index: usize) -> Option<Box<dyn Pass>>

three.js removePass, by position.

Source

pub fn passes(&self) -> &[Box<dyn Pass>]

Source

pub fn passes_mut(&mut self) -> &mut [Box<dyn Pass>]

Source

pub fn pass_names(&self) -> Vec<&'static str>

Source

pub fn is_last_enabled_pass(&self, index: usize) -> bool

three.js isLastEnabledPass.

Source

pub fn set_size(&mut self, width: u32, height: u32)

three.js setSize: the drawing buffer in logical pixels.

Source

pub fn set_pixel_ratio(&mut self, ratio: f32)

three.js setPixelRatio.

Source

pub fn pixel_ratio(&self) -> f32

Source

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

Logical size, as set_size set it.

Source

pub fn drawing_size(&self) -> (u32, u32)

The buffers’ size in device pixels.

Source

pub fn reset(&mut self, target: Option<Target>)

three.js reset: new buffers (target as the first, if given) and writeBuffer back to the first.

Source

pub fn swap_buffers(&mut self)

three.js swapBuffers.

Source

pub fn render_target1(&self) -> Option<&Target>

renderTarget1, once allocated.

Source

pub fn render_target2(&self) -> Option<&Target>

Source

pub fn write_buffer(&self) -> Option<&Target>

three.js writeBuffer, once allocated.

Source

pub fn read_buffer(&self) -> Option<&Target>

three.js readBuffer, once allocated.

Source

pub fn ensure_buffers(&mut self, renderer: &mut dyn PostBackend)

Allocate (or resize) the two buffers now rather than on the first render.

Source

pub fn render( &mut self, renderer: &mut dyn PostBackend, scene: &mut Scene, camera: &dyn Camera, view: &TextureView, )

three.js render(deltaTime) for one scene and camera, drawing the last pass into view (of the format given to new or set_screen_format, the composer’s drawing size). Passes’ scene and camera indices are all 0 here.

Source

pub fn render_to_target( &mut self, renderer: &mut dyn PostBackend, scene: &mut Scene, camera: &dyn Camera, target: Target, )

render into a render target instead of a view.

Source

pub fn render_frame( &mut self, renderer: &mut dyn PostBackend, scenes: &mut [&mut Scene], cameras: &[&dyn Camera], screen: &Screen<'_>, delta: Option<f32>, )

three.js render(deltaTime). scenes and cameras are what the passes’ indices point into; screen is where the last pass draws; delta is seconds since the last frame, taken from the composer’s clock when None.

Source

pub fn read_render_target(&self) -> Option<&Arc<RenderTarget>>

The render target behind readBuffer, for a caller that wants the chain’s result as a texture.

Trait Implementations§

Source§

impl Debug for EffectComposer

Source§

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

Formats the value using the given formatter. 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> 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 + Sync + Send> ⓘ

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> PassThreading for T
where T: Send + Sync + ?Sized,

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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