rafx-api 0.0.2

Rendering framework built on an extensible asset pipeline
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

use crate::metal::RafxTextureMetal;
use crate::RafxError;

pub struct RafxPresentableFrameMetal {
    pub(crate) drawable: metal::CoreAnimationDrawable,

    // This is a cached wrapper around the texture provided by the drawable.
    pub(crate) texture: RafxTextureMetal,
}

impl RafxPresentableFrameMetal {
    pub fn new(drawable: metal::CoreAnimationDrawable) -> Self {
        let texture = RafxTextureMetal::new_from_metal_texture(drawable.texture().to_owned());
        RafxPresentableFrameMetal { drawable, texture }
    }

    pub fn cancel_present(
        self,
        _result: RafxError,
    ) {
        // just drop self
        //TODO: Send result to surface
    }

    pub fn present(self /* command buffers? */) {
        // TODO: wait for something?
        self.drawable.present();
    }

    pub fn texture_ref(&self) -> &RafxTextureMetal {
        // This increments the ref count on the texture
        &self.texture
    }

    pub fn texture(&self) -> RafxTextureMetal {
        // // This increments the ref count on the texture
        // &self.texture
        RafxTextureMetal::new_from_metal_texture(self.drawable.texture().to_owned())
    }
}

/*
impl FrameInFlight {
    // A value that stays in step with the image index returned by the swapchain. There is no
    // guarantee on the ordering of present image index (i.e. it may decrease). It is only promised
    // to not be in use by a frame in flight
    pub fn present_index(&self) -> u32;

    // If true, consider recreating the swapchain
    pub fn is_suboptimal(&self) -> bool;

    // Can be called by the end user to end the frame early and defer a result to the next acquire
    // image call
    pub fn cancel_present(
        self,
        result: VkResult<()>,
    );

    // submit the given command buffers and preset the swapchain image for this frame
    pub fn present(
        self,
        command_buffers: &[vk::CommandBuffer],
    ) -> VkResult<()>;
}
*/