context.h

Go to the documentation of this file.

// Software Rendering Pipeline (SRP) library
// Licensed under GNU GPLv3
 
#pragma once
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "srp/message_callback.h"
#include "srp/arena.h"
 
typedef enum SRPProvokingVertexMode
{
    SRP_PROVOKING_VERTEX_FIRST,  
    SRP_PROVOKING_VERTEX_LAST
} SRPProvokingVertexMode;
 
typedef enum SRPWinding
{
    SRP_WINDING_CCW,  
    SRP_WINDING_CW    
} SRPWinding;
 
typedef enum SRPFace
{
    SRP_FACE_NONE,           
    SRP_FACE_FRONT,          
    SRP_FACE_BACK,           
    SRP_FACE_FRONT_AND_BACK  
} SRPFace;
 
typedef enum SRPPolygonMode
{
    SRP_POLYGON_MODE_FILL,  
    SRP_POLYGON_MODE_LINE,  
    SRP_POLYGON_MODE_POINT  
} SRPPolygonMode;
 
typedef enum SRPCompareOp
{
    SRP_COMPARE_NEVER,
    SRP_COMPARE_ALWAYS,
    SRP_COMPARE_LESS,
    SRP_COMPARE_LEQUAL,
    SRP_COMPARE_GREATER,
    SRP_COMPARE_GEQUAL,
    SRP_COMPARE_EQUAL,
    SRP_COMPARE_NOTEQUAL
} SRPCompareOp;
 
typedef enum {
    SRP_STENCIL_KEEP,       
    SRP_STENCIL_ZERO,       
    SRP_STENCIL_REPLACE,    
    SRP_STENCIL_INCR,       
    SRP_STENCIL_INCR_WRAP,  
    SRP_STENCIL_DECR,       
    SRP_STENCIL_DECR_WRAP,  
    SRP_STENCIL_INVERT      
} SRPStencilOp;
 
 
 
typedef struct SRPRasterState
{
    SRPWinding frontFace;        
    SRPFace cullFace;            
    SRPPolygonMode polygonMode;  
    float pointSize;             
} SRPRasterState;
 
typedef struct SRPScissorState {
    bool enabled;   
    size_t x;       
    size_t y;       
    size_t width;   
    size_t height;  
} SRPScissorState;
 
typedef struct SRPStencilFaceState {
    SRPCompareOp func;     
    uint8_t ref;           
    uint8_t mask;          
    uint8_t writeMask;     
    SRPStencilOp sfailOp;  
    SRPStencilOp dfailOp;  
    SRPStencilOp passOp;   
} SRPStencilFaceState;
 
typedef struct SRPStencilState {
    bool enabled;               
    SRPStencilFaceState front;  
    SRPStencilFaceState back;   
} SRPStencilState;
 
typedef struct SRPDepthState
{
    bool testEnable;         
    bool writeEnable;        
    SRPCompareOp compareOp;  
} SRPDepthState;
 
 
typedef struct SRPContext
{
    SRPMessageCallback messageCallback;
 
    SRPProvokingVertexMode provokingVertexMode;
 
    SRPRasterState raster;    
    SRPScissorState scissor;  
    SRPStencilState stencil;  
    SRPDepthState depth;      
    SRPArena* arena;  
} SRPContext;
 
 
void srpNewContext(SRPContext* pContext);
 
void srpSetMessageCallback(SRPMessageCallback callback);
 
void srpProvokingVertexMode(SRPProvokingVertexMode mode);
 
void srpRasterCullFace(SRPFace face);
void srpRasterFrontFace(SRPWinding face);
void srpRasterPolygonMode(SRPPolygonMode mode);
void srpRasterPointSize(float size);
 
void srpScissorTest(bool enable);
void srpScissorOptions(size_t x, size_t y, size_t width, size_t height);
 
void srpStencilTest(bool enable);
void srpStencilFunc(SRPCompareOp func, uint8_t ref, uint8_t mask);
void srpStencilFuncSeparate(SRPFace face, SRPCompareOp func, uint8_t ref, uint8_t mask);
void srpStencilOp(SRPStencilOp sfail, SRPStencilOp dfail, SRPStencilOp pass);
void srpStencilOpSeparate(SRPFace face, SRPStencilOp sfail, SRPStencilOp dfail, SRPStencilOp pass);
void srpStencilWriteMask(uint8_t mask);
void srpStencilWriteMaskSeparate(SRPFace face, uint8_t mask);
 
void srpDepthTest(bool enable);
void srpDepthWrite(bool enable);
void srpDepthCompareOp(SRPCompareOp op);
 
 
extern SRPContext srpContext;