renderer_interface.h

/*
 * Fermat
 *
 * Copyright (c) 2016-2019, NVIDIA CORPORATION. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    * Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *    * Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *    * Neither the name of the NVIDIA CORPORATION nor the
 *      names of its contributors may be used to endorse or promote products
 *      derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NVIDIA CORPORATION BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include <types.h>
#include <stdio.h>

struct RenderingContext;
struct FBufferStorage;
struct RendererInterface;

typedef RendererInterface* (*RendererFactoryFunction)();


struct FERMAT_API RendererInterface
{
    virtual uint32 auxiliary_channel_count() { return 0; }

    virtual void register_auxiliary_channels(FBufferStorage& fbuffer, const uint32 channel_offset) {}

    virtual void init(int argc, char** argv, RenderingContext& renderer) {}

    virtual void update_scene(RenderingContext& renderer) {}

    virtual void render(const uint32 instance, RenderingContext& renderer) {}

    virtual void keyboard(unsigned char character, int x, int y, bool& invalidate) {}

    virtual void destroy() {}

    virtual void mouse(RenderingContext& renderer, int button, int state, int x, int y) {}

    virtual void draw(RenderingContext& renderer) {}

    virtual void dump_speed_stats(FILE* stats) {}
};