fyrox_graphics/read_buffer.rs
1// Copyright (c) 2019-present Dmitry Stepanov and Fyrox Engine contributors.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in all
11// copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19// SOFTWARE.
20
21use crate::{
22 core::{math::Rect, Downcast},
23 error::FrameworkError,
24 framebuffer::FrameBuffer,
25};
26use bytemuck::Pod;
27
28pub trait AsyncReadBuffer: Downcast {
29 fn schedule_pixels_transfer(
30 &mut self,
31 framebuffer: &dyn FrameBuffer,
32 color_buffer_index: u32,
33 rect: Option<Rect<i32>>,
34 ) -> Result<(), FrameworkError>;
35 fn is_request_running(&self) -> bool;
36 fn try_read(&mut self) -> Option<Vec<u8>>;
37}
38
39impl dyn AsyncReadBuffer {
40 pub fn try_read_of_type<T>(&mut self) -> Option<Vec<T>>
41 where
42 T: Pod,
43 {
44 let mut bytes = self.try_read()?;
45 let typed = unsafe {
46 Some(Vec::from_raw_parts(
47 bytes.as_mut_ptr() as *mut T,
48 bytes.len() / size_of::<T>(),
49 bytes.capacity() / size_of::<T>(),
50 ))
51 };
52 std::mem::forget(bytes);
53 typed
54 }
55}