alex/pixels
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Expose new API method render_texture_format(). (#123)

Browse source 
This method is needed to let the user of the API configure the texture
format of the target texture/render texture that the surface texture is
rendered on. This texture format is hardware/platform dependent.

For example, this method makes it possible to use the pixels crate on
Android because Android seems not to use the previously hard-coded
texture format wgpu::TextureFormat::Bgra8UnormSrgb.
This commit is contained in:
schnippl0r 2020-12-11 03:40:06 +01:00 committed by GitHub
parent e5f92519f1
commit fb243b8973
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 29 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
src/lib.rs
View file

@ -92,6 +92,7 @@ pub struct Pixels<W: HasRawWindowHandle> {
context: PixelsContext,
surface_size: SurfaceSize,
present_mode: wgpu::PresentMode,
render_texture_format: wgpu::TextureFormat,
_phantom: std::marker::PhantomData<W>,
// Pixel buffer
@ -113,6 +114,7 @@ pub struct PixelsBuilder<'req, 'win, W: HasRawWindowHandle> {
present_mode: wgpu::PresentMode,
surface_texture: SurfaceTexture<'win, W>,
texture_format: wgpu::TextureFormat,
render_texture_format: wgpu::TextureFormat,
}
/// All the ways in which creating a pixel buffer can fail.
@ -222,7 +224,7 @@ impl<'win, W: HasRawWindowHandle> Pixels<W> {
&self.context.surface,
&wgpu::SwapChainDescriptor {
usage: wgpu::TextureUsage::OUTPUT_ATTACHMENT,
format: wgpu::TextureFormat::Bgra8UnormSrgb,
format: self.render_texture_format,
width: self.surface_size.width,
height: self.surface_size.height,
present_mode: self.present_mode,
@ -511,6 +513,7 @@ impl<'req, 'win, W: HasRawWindowHandle> PixelsBuilder<'req, 'win, W> {
present_mode: wgpu::PresentMode::Fifo,
surface_texture,
texture_format: wgpu::TextureFormat::Rgba8UnormSrgb,
render_texture_format: wgpu::TextureFormat::Bgra8UnormSrgb,
}
}
@ -601,6 +604,19 @@ impl<'req, 'win, W: HasRawWindowHandle> PixelsBuilder<'req, 'win, W> {
self
}
/// Set the render texture format.
///
/// The default value is [`wgpu::TextureFormat::Bgra8UnormSrgb`], which is 4 unsigned bytes in
/// `BGRA` order using the SRGB color space. This format depends on the hardware/platform the
/// pixel buffer is rendered to/for.
pub fn render_texture_format(
mut self,
texture_format: wgpu::TextureFormat,
) -> PixelsBuilder<'req, 'win, W> {
self.render_texture_format = texture_format;
self
}
/// Create a pixel buffer from the options builder.
///
/// # Errors
@ -663,7 +679,7 @@ impl<'req, 'win, W: HasRawWindowHandle> PixelsBuilder<'req, 'win, W> {
&surface,
&wgpu::SwapChainDescriptor {
usage: wgpu::TextureUsage::OUTPUT_ATTACHMENT,
format: wgpu::TextureFormat::Bgra8UnormSrgb,
format: self.render_texture_format,
width: surface_size.width,
height: surface_size.height,
present_mode,
@ -677,7 +693,12 @@ impl<'req, 'win, W: HasRawWindowHandle> PixelsBuilder<'req, 'win, W> {
.transform
.inversed();
let scaling_renderer = ScalingRenderer::new(&device, &texture_view, &texture_extent);
let scaling_renderer = ScalingRenderer::new(
&device,
&texture_view,
&texture_extent,
self.render_texture_format,
);
let context = PixelsContext {
device,
@ -697,6 +718,7 @@ impl<'req, 'win, W: HasRawWindowHandle> PixelsBuilder<'req, 'win, W> {
_phantom: std::marker::PhantomData,
pixels,
scaling_matrix_inverse,
render_texture_format: self.render_texture_format,
})
}
}

5
src/renderers.rs
View file

@ -9,6 +9,7 @@ pub struct ScalingRenderer {
render_pipeline: wgpu::RenderPipeline,
width: f32,
height: f32,
render_texture_format: wgpu::TextureFormat,
}
impl ScalingRenderer {
@ -16,6 +17,7 @@ impl ScalingRenderer {
device: &wgpu::Device,
texture_view: &wgpu::TextureView,
texture_size: &wgpu::Extent3d,
render_texture_format: wgpu::TextureFormat,
) -> Self {
let vs_module = device.create_shader_module(wgpu::include_spirv!("../shaders/vert.spv"));
let fs_module = device.create_shader_module(wgpu::include_spirv!("../shaders/frag.spv"));
@ -126,7 +128,7 @@ impl ScalingRenderer {
}),
primitive_topology: wgpu::PrimitiveTopology::TriangleList,
color_states: &[wgpu::ColorStateDescriptor {
format: wgpu::TextureFormat::Bgra8UnormSrgb,
format: render_texture_format,
color_blend: wgpu::BlendDescriptor::REPLACE,
alpha_blend: wgpu::BlendDescriptor::REPLACE,
write_mask: wgpu::ColorWrite::ALL,
@ -147,6 +149,7 @@ impl ScalingRenderer {
render_pipeline,
width: texture_size.width as f32,
height: texture_size.height as f32,
render_texture_format,
}
}