graphics.h

Go to the documentation of this file.

#pragma once
 
#include <liboscar/graphics/blit_flags.h>
#include <liboscar/graphics/cubemap_face.h>
#include <liboscar/graphics/render_pass_config.h>
#include <liboscar/maths/rect.h>
 
#include <cstddef>
#include <optional>
 
namespace osc { class Camera; }
namespace osc { class Cubemap; }
namespace osc { class Material; }
namespace osc { class RenderQueue; }
namespace osc { class RenderTarget; }
namespace osc { class RenderTexture; }
namespace osc { class SharedDepthStencilRenderBuffer; }
namespace osc { class Texture2D; }
 
// rendering functions
//
// these perform the necessary backend steps to get something useful done
namespace osc::graphics
{
    void render_to_main_window(                     const RenderQueue&, const Camera&, const RenderPassConfig& = {});
    void render_to(RenderTexture&,                  const RenderQueue&, const Camera&, const RenderPassConfig& = {});
    void render_to(const RenderTarget&,             const RenderQueue&, const Camera&, const RenderPassConfig& = {});
    void render_to(SharedDepthStencilRenderBuffer&, const RenderQueue&, const Camera&, const RenderPassConfig& = {});
 
    // Blits the `Texture` to the `RenderTexture`.
    void blit(
        const Texture2D&,
        RenderTexture&
    );
 
    // Blits `render_texture` into a rectangular region of the main window.
    //
    // If provided, `destination_screen_rect` should be defined in screen space
    // and device-independent pixels. Screen space starts in the bottom-left
    // corner and ends in the top-right corner. If it is not provided, the
    // destination region will be the entire contents of the main window.
    void blit_to_main_window(
        const RenderTexture& render_texture,
        std::optional<Rect> destination_screen_rect = std::nullopt,
        BlitFlags = {}
    );
 
    // Renders `render_texture` as a quad using `material` into a rectangular region
    // of the main window.
    //
    // `material` should have a `sampler2D` or `samplerCube` property called
    // "uTexture". `texture` will be assigned to this property. `texture`'s
    // `dimensionality()` dictates whether a `sampler2D` or `samplerCube` is
    // required in the shader.
    //
    // If provided, `destination_screen_rect` should be defined in screen space
    // and device-independent pixels. Screen space starts in the bottom-left
    // corner and ends in the top-right corner. If it is not provided, the
    // destination region will be the entire contents of the main window.
    void blit_to_main_window(
        const RenderTexture& render_texture,
        const Material& material,
        std::optional<Rect> destination_screen_rect = std::nullopt,
        BlitFlags = {}
    );
 
    // Blits the texture into a rectangular region in the main window.
    //
    // The rectangle should be defined in screen space, which:
    //
    // - Is measured in device-independent pixels
    // - Starts in the bottom-left corner
    // - Ends in the top-right corner
    void blit_to_main_window(
        const Texture2D&,
        const Rect&
    );
 
    // copy: copy a GPU texture to a (potentially, CPU-accessible) texture
 
    void copy_texture(
        const RenderTexture&,
        Texture2D&
    );
 
    void copy_texture(
        const RenderTexture&,
        Texture2D&,
        CubemapFace
    );
 
    void copy_texture(
        const RenderTexture&,
        Cubemap&,
        size_t mipmap_level
    );
}