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    define_shared_wrapper,
24    error::FrameworkError,
25    framebuffer::GpuFrameBufferTrait,
26};
27use bytemuck::Pod;
28
29pub trait GpuAsyncReadBufferTrait: Downcast {
30    fn schedule_pixels_transfer(
31        &self,
32        framebuffer: &dyn GpuFrameBufferTrait,
33        color_buffer_index: u32,
34        rect: Option<Rect<i32>>,
35    ) -> Result<(), FrameworkError>;
36    fn is_request_running(&self) -> bool;
37    fn try_read(&self) -> Option<Vec<u8>>;
38}
39
40impl dyn GpuAsyncReadBufferTrait {
41    pub fn try_read_of_type<T>(&self) -> Option<Vec<T>>
42    where
43        T: Pod,
44    {
45        let mut bytes = self.try_read()?;
46        let typed = unsafe {
47            Some(Vec::from_raw_parts(
48                bytes.as_mut_ptr() as *mut T,
49                bytes.len() / size_of::<T>(),
50                bytes.capacity() / size_of::<T>(),
51            ))
52        };
53        std::mem::forget(bytes);
54        typed
55    }
56}
57
58define_shared_wrapper!(GpuAsyncReadBuffer<dyn GpuAsyncReadBufferTrait>);