ngf_render_pass_info Struct Reference

Data Fields
ngf_render_target	render_target
const ngf_attachment_load_op *	load_ops
const ngf_attachment_store_op *	store_ops
const ngf_clear *	clears

Detailed Description

Information required to begin a render pass.

Field Documentation

clears

const ngf_clear* ngf_render_pass_info::clears

If no attachment has a clear as its load op, this field may be NULL. Otherwise, it shall be a pointer to a buffer of ngf_clear objects. The buffer must contain at least as many elements as there are attachments in the render target. The ith element of the buffer corresponds to the ith attachment. For attachments that are to be cleared at the beginning of the pass, the clear values from the corresponding element of the buffer are used. The rest of the buffer's elements are ignored.

load_ops

const ngf_attachment_load_op* ngf_render_pass_info::load_ops

A pointer to a buffer of ngf_load_op enumerators specifying the operation to perform at the start of the render pass for each attachment of ngf_render_pass_info::render_target. The buffer must have at least the same number of elements as there are attachments in the render target. The ith element of the buffer corresponds to the ith attachment.

render_target

ngf_render_target ngf_render_pass_info::render_target

A render target that shall be rendered to during this pass.

store_ops

const ngf_attachment_store_op* ngf_render_pass_info::store_ops

A pointer to a buffer of ngf_store_op enumerators specifying the operation to perform at the end of the render pass for each attachment of ngf_render_pass_info::render_target. The buffer must have at least the same number of elements as there are attachments in the render target. The ith element of the buffer corresponds to the ith attachment.