pub struct EffectComposer {
pub render_to_screen: bool,
/* private fields */
}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: boolthree.js renderToScreen: the last enabled pass draws to the screen.
Implementations§
Source§impl EffectComposer
impl EffectComposer
Sourcepub fn with_size(width: u32, height: u32) -> Self
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.
Sourcepub fn new(
_device: Arc<Device>,
_queue: Arc<Queue>,
width: u32,
height: u32,
format: TextureFormat,
) -> Self
pub fn new( _device: Arc<Device>, _queue: Arc<Queue>, width: u32, height: u32, format: TextureFormat, ) -> Self
Sourcepub fn with_target(target: Target) -> Self
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.
Sourcepub fn set_screen_format(&mut self, format: TextureFormat)
pub fn set_screen_format(&mut self, format: TextureFormat)
The format of the views render draws into.
pub fn screen_format(&self) -> TextureFormat
Sourcepub fn add_pass(&mut self, pass: impl Pass + 'static) -> &mut Self
pub fn add_pass(&mut self, pass: impl Pass + 'static) -> &mut Self
three.js addPass: append, and size the pass to the composer.
Sourcepub fn add_boxed(&mut self, pass: Box<dyn Pass>) -> &mut Self
pub fn add_boxed(&mut self, pass: Box<dyn Pass>) -> &mut Self
add_pass for a pass already boxed.
Sourcepub fn insert_boxed(&mut self, pass: Box<dyn Pass>, index: usize)
pub fn insert_boxed(&mut self, pass: Box<dyn Pass>, index: usize)
three.js insertPass.
Sourcepub fn remove_pass(&mut self, index: usize) -> Option<Box<dyn Pass>>
pub fn remove_pass(&mut self, index: usize) -> Option<Box<dyn Pass>>
three.js removePass, by position.
pub fn passes(&self) -> &[Box<dyn Pass>]
pub fn passes_mut(&mut self) -> &mut [Box<dyn Pass>]
pub fn pass_names(&self) -> Vec<&'static str>
Sourcepub fn is_last_enabled_pass(&self, index: usize) -> bool
pub fn is_last_enabled_pass(&self, index: usize) -> bool
three.js isLastEnabledPass.
Sourcepub fn set_size(&mut self, width: u32, height: u32)
pub fn set_size(&mut self, width: u32, height: u32)
three.js setSize: the drawing buffer in logical pixels.
Sourcepub fn set_pixel_ratio(&mut self, ratio: f32)
pub fn set_pixel_ratio(&mut self, ratio: f32)
three.js setPixelRatio.
pub fn pixel_ratio(&self) -> f32
Sourcepub fn drawing_size(&self) -> (u32, u32)
pub fn drawing_size(&self) -> (u32, u32)
The buffers’ size in device pixels.
Sourcepub fn reset(&mut self, target: Option<Target>)
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.
Sourcepub fn swap_buffers(&mut self)
pub fn swap_buffers(&mut self)
three.js swapBuffers.
Sourcepub fn render_target1(&self) -> Option<&Target>
pub fn render_target1(&self) -> Option<&Target>
renderTarget1, once allocated.
pub fn render_target2(&self) -> Option<&Target>
Sourcepub fn write_buffer(&self) -> Option<&Target>
pub fn write_buffer(&self) -> Option<&Target>
three.js writeBuffer, once allocated.
Sourcepub fn read_buffer(&self) -> Option<&Target>
pub fn read_buffer(&self) -> Option<&Target>
three.js readBuffer, once allocated.
Sourcepub fn ensure_buffers(&mut self, renderer: &mut dyn PostBackend)
pub fn ensure_buffers(&mut self, renderer: &mut dyn PostBackend)
Allocate (or resize) the two buffers now rather than on the first render.
Sourcepub fn render(
&mut self,
renderer: &mut dyn PostBackend,
scene: &mut Scene,
camera: &dyn Camera,
view: &TextureView,
)
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.
Sourcepub fn render_to_target(
&mut self,
renderer: &mut dyn PostBackend,
scene: &mut Scene,
camera: &dyn Camera,
target: Target,
)
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.
Sourcepub fn render_frame(
&mut self,
renderer: &mut dyn PostBackend,
scenes: &mut [&mut Scene],
cameras: &[&dyn Camera],
screen: &Screen<'_>,
delta: Option<f32>,
)
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.
Sourcepub fn read_render_target(&self) -> Option<&Arc<RenderTarget>>
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§
Auto Trait Implementations§
impl !RefUnwindSafe for EffectComposer
impl !UnwindSafe for EffectComposer
impl Forget for EffectComposer
impl Freeze for EffectComposer
impl Move for EffectComposer
impl Send for EffectComposer
impl Sync for EffectComposer
impl Unpin for EffectComposer
impl UnsafeUnpin for EffectComposer
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&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> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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