Struct bgfx_rs::static_lib::FrameBuffer

pub struct FrameBuffer { /* private fields */ }

Implementations

impl FrameBuffer

pub fn create_frame_buffer(
    width: u16,
    height: u16,
    format: TextureFormat,
    texture_flags: u64
) -> FrameBuffer

• width: Texture width.
• height: Texture height.
• format: Texture format. See: TextureFormat.
• texture_flags: Texture creation (see TextureFlags.), and sampler (see SamplerFlags) flags. Default texture sampling mode is linear, and wrap mode is repeat.

• [SamplerFlags::[U/V/W]_[MIRROR/CLAMP]] - Mirror or clamp to edge wrap mode.
• [SamplerFlags::[MIN/MAG/MIP]_[POINT/ANISOTROPIC]] - Point or anisotropic sampling.

pub fn create_frame_buffer_scaled(
    ratio: BackbufferRatio,
    format: TextureFormat,
    texture_flags: u64
) -> FrameBuffer

• ratio: Frame buffer size in respect to back-buffer size. See: BackbufferRatio.
• format: Texture format. See: TextureFormat.
• texture_flags: Texture creation (see TextureFlags.), and sampler (see SamplerFlags) flags. Default texture sampling mode is linear, and wrap mode is repeat.

• [SamplerFlags::[U/V/W]_[MIRROR/CLAMP]] - Mirror or clamp to edge wrap mode.
• [SamplerFlags::[MIN/MAG/MIP]_[POINT/ANISOTROPIC]] - Point or anisotropic sampling.

pub fn create_frame_buffer_from_handles(
    num: u8,
    handles: &Texture,
    destroy_texture: bool
) -> FrameBuffer

• num: Number of texture handles.
• handles: Texture attachments.
• destroy_texture: If true, textures will be destroyed when frame buffer is destroyed.

pub fn create_frame_buffer_from_attachment(
    num: u8,
    attachment: &Attachment,
    destroy_texture: bool
) -> FrameBuffer

• num: Number of attachments.
• attachment: Attachment texture info. See: bgfx::Attachment.
• destroy_texture: If true, textures will be destroyed when frame buffer is destroyed.

pub fn create_frame_buffer_from_nwh(
    nwh: *mut c_void,
    width: u16,
    height: u16,
    params: CreateFrameBufferFromNwhArgs
) -> FrameBuffer

• nwh: OS’ target native window handle.
• width: Window back buffer width.
• height: Window back buffer height.
• format: Window back buffer color format.
• depth_format: Window back buffer depth format.

pub fn set_name(&self, name: &str)

• handle: Frame buffer handle.
• name: Frame buffer name.
• len: Frame buffer name length (if length is INT32_MAX, it’s expected that _name is zero terminated string.

pub fn get_texture(&self, attachment: u8) -> Texture

• handle: Frame buffer handle.
• attachment:

pub fn request_screen_shot(&self, file_path: &i8)

• handle: Frame buffer handle. If handle is ]BGFX_INVALID_HANDLE] request will be made for main window back buffer.
• file_path: Will be passed to bgfx::CallbackI::screenShot callback.

Trait Implementations

impl Clone for FrameBuffer

fn clone(&self) -> FrameBuffer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FrameBuffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for FrameBuffer

fn drop(&mut self)

Executes the destructor for this type.