8000 metal: keep transient render textures' samples in tile memory by benface · Pull Request #680 · not-fl3/miniquad · GitHub
[go: up one dir, main page]
Skip to content

metal: keep transient render textures' samples in tile memory #680

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
benface wants to merge 1 commit into
base: master
Choose a base branch
from
Open

metal: keep transient render textures' samples in tile memory #680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/graphics.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,15 @@ pub struct TextureParams {
/// be created instead of a regulat texture.
///
pub sample_count: i32,
/// Only used for render textures. A transient render texture's contents
/// last only as long as the pass drawing into it: a pass that doesn't
/// clear it starts with them undefined, and only what a multisampled one
/// resolves into outlives the pass.
///
/// On Metal, a GPU with tile memory keeps them there alone, so the
/// texture takes up no memory, and no pass stores them. OpenGL keeps them
/// as it does any texture's.
pub transient: bool,
}

impl Default for TextureParams {
Expand All @@ -415,6 +424,7 @@ impl Default for TextureParams {
height: 0,
allocate_mipmaps: false,
sample_count: 1,
transient: false,
}
}
}
Expand Down Expand Up @@ -1160,6 +1170,7 @@ pub trait RenderingBackend {
mipmap_filter: MipmapFilterMode::None,
allocate_mipmaps: false,
sample_count: 1,
transient: false,
},
)
}
Expand Down
84 changes: 62 additions & 22 deletions src/graphics/metal.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,19 @@ const UNIFORM_BUFFER_ALIGN: u64 = 256;
))]
const UNIFORM_BUFFER_ALIGN: u64 = 16;

/// What a color attachment keeps as its pass ends. A multisampled one
/// that isn't transient keeps its samples as well as resolving them
/// (`StoreAndMultisampleResolve`), so a later pass into the same target
/// can load them back.
fn color_store_action(resolves: bool, transient: bool) -> MTLStoreAction {
match (resolves, transient) {
(true, true) => MTLStoreAction::MultisampleResolve,
(true, false) => MTLStoreAction::StoreAndMultisampleResolve,
(false, true) => MTLStoreAction::DontCare,
(false, false) => MTLStoreAction::Store,
}
}

impl From<VertexFormat> for MTLVertexFormat {
fn from(vf: VertexFormat) -> Self {
match vf {
Expand Down Expand Up @@ -295,6 +308,9 @@ pub struct MetalContext {
pending_end_encoder: bool,
view: ObjcId,
device: ObjcId,
/// Whether the GPU can keep a texture in tile memory alone, for
/// transient textures.
memoryless: bool,
current_frame_index: usize,
uniform_buffers: [ObjcId; 3],
// cached index_buffer from apply_bindings
Expand Down Expand Up @@ -371,6 +387,17 @@ impl MetalContext {
#[cfg(any(target_os = "ios", target_os = "tvos"))]
let options = { MTLResourceOptions::CPUCacheModeWriteCombined };

// Apple's own GPUs, which are all tile-based, can keep a
// texture in tile memory alone. `supportsFamily:` came with
// iOS 13 and macOS 10.15.
let memoryless = {
let responds: BOOL = msg_send![device, respondsToSelector: sel!(supportsFamily:)];
responds == YES && {
let apple: BOOL = msg_send![device, supportsFamily: MTLGPUFamily::Apple1];
apple == YES
}
};

let uniform_buffers = [
msg_send![device, newBufferWithLength:MAX_UNIFORM_BUFFER_SIZE
options:options],
Expand All @@ -390,6 +417,7 @@ impl MetalContext {
pending_end_encoder: false,
view,
device,
memoryless,
buffers: vec![],
shaders: vec![],
pipelines: vec![],
Expand Down Expand Up @@ -615,9 +643,9 @@ impl RenderingBackend for MetalContext {
msg_send_![render_pass_desc, retain];
assert!(!render_pass_desc.is_null());
for (i, color_img) in color_img.iter().enumerate() {
let color_texture = self.textures.get(*color_img).texture;
let color = self.textures.get(*color_img);
let color_attachment = msg_send_![msg_send_![render_pass_desc, colorAttachments], objectAtIndexedSubscript:i];
msg_send_![color_attachment, setTexture: color_texture];
msg_send_![color_attachment, setTexture: color.texture];
msg_send_![color_attachment, setLoadAction: MTLLoadAction::Clear];
// Multisample resolve: when the caller passes a resolve
// texture for this attachment, downsample into it on
Expand All @@ -629,17 +657,25 @@ impl RenderingBackend for MetalContext {
color_attachment,
setStoreAction: MTLStoreAction::MultisampleResolve
];
} else if color.params.transient {
msg_send_![color_attachment, setStoreAction: MTLStoreAction::DontCare];
} else {
msg_send_![color_attachment, setStoreAction: MTLStoreAction::Store];
}
}
if let Some(depth_img) = depth_img {
let depth_texture = self.textures.get(depth_img).texture;
let depth = self.textures.get(depth_img);
let depth_texture = depth.texture;

let depth_attachment = msg_send_![render_pass_desc, depthAttachment];
msg_send_![depth_attachment, setTexture: depth_texture];
msg_send_![depth_attachment, setLoadAction: MTLLoadAction::Clear];
msg_send_![depth_attachment, setStoreAction: MTLStoreAction::Store];
let depth_store_action = if depth.params.transient {
MTLStoreAction::DontCare
} else {
MTLStoreAction::Store
};
msg_send_![depth_attachment, setStoreAction: depth_store_action];
msg_send_![depth_attachment, setClearDepth:1.];

let stencil_attachment = msg_send_![render_pass_desc, stencilAttachment];
Expand Down Expand Up @@ -817,7 +853,12 @@ impl RenderingBackend for MetalContext {
msg_send![self.view, colorPixelFormat];
msg_send_![descriptor, setPixelFormat: view_pixel_format];
}
msg_send_![descriptor, setStorageMode: MTLStorageMode::Private];
let storage_mode = if params.transient && self.memoryless {
MTLStorageMode::Memoryless
} else {
MTLStorageMode::Private
};
msg_send_![descriptor, setStorageMode: storage_mode];
if params.sample_count > 1 {
// MSAA target — render-only, no mipmaps, no
// shader-sample (the resolve texture is sampled
Expand Down Expand Up @@ -1310,7 +1351,7 @@ impl RenderingBackend for MetalContext {
self.command_buffer = Some(msg_send![self.command_queue, commandBuffer]);
}

let (descriptor, width_px, height_px) = match pass {
let (descriptor, width_px, height_px, transient) = match pass {
None => {
// Read dimensions from the actual pass attachment
// texture, not `screen_size()`. MTKView's
Expand All @@ -1326,7 +1367,7 @@ impl RenderingBackend for MetalContext {
let texture: ObjcId = msg_send_![attachment, texture];
let width: u64 = msg_send![texture, width];
let height: u64 = msg_send![texture, height];
(descriptor, width as u32, height as u32)
(descriptor, width as u32, height as u32, false)
}
Some(pass) => {
let pass = &self.passes[pass.0];
Expand All @@ -1338,11 +1379,13 @@ impl RenderingBackend for MetalContext {
.copied()
//.or(pass.depth_texture)
.unwrap();
8000 let params = self.textures.get(texture).params;

(
pass.render_pass_desc,
self.textures.get(texture).params.width,
self.textures.get(texture).params.height,
params.width,
params.height,
params.transient,
)
}
};
Expand All @@ -1353,19 +1396,11 @@ impl RenderingBackend for MetalContext {
let color_attachments = msg_send_![descriptor, colorAttachments];
let color_attachment = msg_send_![color_attachments, objectAtIndexedSubscript: 0];

// If the attachment has a resolve texture, use
// `StoreAndMultisampleResolve` (not just
// `MultisampleResolve`) so the multisample texture
// survives target-switch boundaries within a frame —
// a later `Load` on the same target would otherwise
// read discarded memory.
let resolve_texture: ObjcId = msg_send![color_attachment, resolveTexture];
let store_action = if resolve_texture.is_null() {
MTLStoreAction::Store
} else {
MTLStoreAction::StoreAndMultisampleResolve
};
msg_send_![color_attachment, setStoreAction: store_action];
msg_send_![
color_attachment,
setStoreAction: color_store_action(!resolve_texture.is_null(), transient)
];

match action {
PassAction::Clear { color, .. } => {
Expand All @@ -1376,7 +1411,12 @@ impl RenderingBackend for MetalContext {
}
}
PassAction::Nothing => {
msg_send_![color_attachment, setLoadAction: MTLLoadAction::Load];
let load_action = if transient {
MTLLoadAction::DontCare
} else {
MTLLoadAction::Load
};
msg_send_![color_attachment, setLoadAction: load_action];
}
}

Expand Down
6 changes: 6 additions & 0 deletions src/native/apple/frameworks.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -827,6 +827,12 @@ pub enum MTLTextureUsage {
PixelFormatView = 0x0010,
}

#[repr(i64)]
#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
pub enum MTLGPUFamily {
Apple1 = 1001,
}

#[repr(u64)]
#[allow(non_camel_case_types)]
#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
Expand Down
Loading
0