a12a8a71bb
The goal is to solve confusion of the "All rights reserved" for licensing
code under an open-source license.
The phrase "All rights reserved" comes from a historical convention that
required this phrase for the copyright protection to apply. This convention
is no longer relevant.
However, even though the phrase has no meaning in establishing the copyright
it has not lost meaning in terms of licensing.
This change makes it so code under the Blender Foundation copyright does
not use "all rights reserved". This is also how the GPL license itself
states how to apply it to the source code:
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software ...
This change does not change copyright notice in cases when the copyright
is dual (BF and an author), or just an author of the code. It also does
mot change copyright which is inherited from NaN Holding BV as it needs
some further investigation about what is the proper way to handle it.
145 lines
5.3 KiB
C
145 lines
5.3 KiB
C
/* SPDX-License-Identifier: GPL-2.0-or-later
|
||
* Copyright 2016 Blender Foundation */
|
||
|
||
/** \file
|
||
* \ingroup gpu
|
||
*
|
||
* GPU immediate mode work-alike
|
||
*/
|
||
|
||
#pragma once
|
||
|
||
#include "GPU_batch.h"
|
||
#include "GPU_immediate_util.h"
|
||
#include "GPU_primitive.h"
|
||
#include "GPU_shader.h"
|
||
#include "GPU_texture.h"
|
||
#include "GPU_vertex_format.h"
|
||
|
||
#ifdef __cplusplus
|
||
extern "C" {
|
||
#endif
|
||
|
||
/** Returns a cleared vertex format, ready for #add_attr. */
|
||
GPUVertFormat *immVertexFormat(void);
|
||
|
||
/** Every #immBegin must have a program bound first. */
|
||
void immBindShader(GPUShader *shader);
|
||
/** Call after your last immEnd, or before binding another program. */
|
||
void immUnbindProgram(void);
|
||
|
||
/** Must supply exactly vertex_len vertices. */
|
||
void immBegin(GPUPrimType, uint vertex_len);
|
||
/** Can supply fewer vertices. */
|
||
void immBeginAtMost(GPUPrimType, uint max_vertex_len);
|
||
void immEnd(void); /* finishes and draws. */
|
||
|
||
/* - #immBegin a batch, then use standard `imm*` functions as usual.
|
||
* - #immEnd will finalize the batch instead of drawing.
|
||
*
|
||
* Then you can draw it as many times as you like!
|
||
* Partially replaces the need for display lists. */
|
||
|
||
GPUBatch *immBeginBatch(GPUPrimType, uint vertex_len);
|
||
GPUBatch *immBeginBatchAtMost(GPUPrimType, uint vertex_len);
|
||
|
||
/* Provide attribute values that can change per vertex. */
|
||
/* First vertex after immBegin must have all its attributes specified. */
|
||
/* Skipped attributes will continue using the previous value for that attr_id. */
|
||
void immAttr1f(uint attr_id, float x);
|
||
void immAttr2f(uint attr_id, float x, float y);
|
||
void immAttr3f(uint attr_id, float x, float y, float z);
|
||
void immAttr4f(uint attr_id, float x, float y, float z, float w);
|
||
|
||
void immAttr2i(uint attr_id, int x, int y);
|
||
|
||
void immAttr1u(uint attr_id, uint x);
|
||
|
||
void immAttr2s(uint attr_id, short x, short y);
|
||
|
||
void immAttr2fv(uint attr_id, const float data[2]);
|
||
void immAttr3fv(uint attr_id, const float data[3]);
|
||
void immAttr4fv(uint attr_id, const float data[4]);
|
||
|
||
void immAttr3ub(uint attr_id, unsigned char r, unsigned char g, unsigned char b);
|
||
void immAttr4ub(uint attr_id, unsigned char r, unsigned char g, unsigned char b, unsigned char a);
|
||
|
||
void immAttr3ubv(uint attr_id, const unsigned char data[3]);
|
||
void immAttr4ubv(uint attr_id, const unsigned char data[4]);
|
||
|
||
/* Explicitly skip an attribute.
|
||
* This advanced option kills automatic value copying for this attr_id. */
|
||
|
||
void immAttrSkip(uint attr_id);
|
||
|
||
/* Provide one last attribute value & end the current vertex.
|
||
* This is most often used for 2D or 3D position (similar to #glVertex). */
|
||
|
||
void immVertex2f(uint attr_id, float x, float y);
|
||
void immVertex3f(uint attr_id, float x, float y, float z);
|
||
void immVertex4f(uint attr_id, float x, float y, float z, float w);
|
||
|
||
void immVertex2i(uint attr_id, int x, int y);
|
||
|
||
void immVertex2s(uint attr_id, short x, short y);
|
||
|
||
void immVertex2fv(uint attr_id, const float data[2]);
|
||
void immVertex3fv(uint attr_id, const float data[3]);
|
||
|
||
void immVertex2iv(uint attr_id, const int data[2]);
|
||
|
||
/* Provide uniform values that don't change for the entire draw call. */
|
||
|
||
void immUniform1i(const char *name, int x);
|
||
void immUniform1f(const char *name, float x);
|
||
void immUniform2f(const char *name, float x, float y);
|
||
void immUniform2fv(const char *name, const float data[2]);
|
||
void immUniform3f(const char *name, float x, float y, float z);
|
||
void immUniform3fv(const char *name, const float data[3]);
|
||
void immUniform4f(const char *name, float x, float y, float z, float w);
|
||
void immUniform4fv(const char *name, const float data[4]);
|
||
/**
|
||
* Note array index is not supported for name (i.e: "array[0]").
|
||
*/
|
||
void immUniformArray4fv(const char *bare_name, const float *data, int count);
|
||
void immUniformMatrix4fv(const char *name, const float data[4][4]);
|
||
|
||
void immBindTexture(const char *name, GPUTexture *tex);
|
||
void immBindTextureSampler(const char *name, GPUTexture *tex, eGPUSamplerState state);
|
||
void immBindUniformBuf(const char *name, GPUUniformBuf *ubo);
|
||
|
||
/* Convenience functions for setting "uniform vec4 color". */
|
||
/* The RGB functions have implicit alpha = 1.0. */
|
||
|
||
void immUniformColor4f(float r, float g, float b, float a);
|
||
void immUniformColor4fv(const float rgba[4]);
|
||
void immUniformColor3f(float r, float g, float b);
|
||
void immUniformColor3fv(const float rgb[3]);
|
||
void immUniformColor3fvAlpha(const float rgb[3], float a);
|
||
|
||
void immUniformColor3ub(unsigned char r, unsigned char g, unsigned char b);
|
||
void immUniformColor4ub(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
|
||
void immUniformColor3ubv(const unsigned char rgb[3]);
|
||
void immUniformColor3ubvAlpha(const unsigned char rgb[3], unsigned char a);
|
||
void immUniformColor4ubv(const unsigned char rgba[4]);
|
||
|
||
/**
|
||
* Extend #immBindShader to use Blender’s library of built-in shader programs.
|
||
* Use #immUnbindProgram() when done.
|
||
*/
|
||
void immBindBuiltinProgram(eGPUBuiltinShader shader_id);
|
||
|
||
/** Extend #immUniformColor to take Blender's themes. */
|
||
void immUniformThemeColor(int color_id);
|
||
void immUniformThemeColorAlpha(int color_id, float a);
|
||
void immUniformThemeColor3(int color_id);
|
||
void immUniformThemeColorShade(int color_id, int offset);
|
||
void immUniformThemeColorShadeAlpha(int color_id, int color_offset, int alpha_offset);
|
||
void immUniformThemeColorBlendShade(int color_id1, int color_id2, float fac, int offset);
|
||
void immUniformThemeColorBlend(int color_id1, int color_id2, float fac);
|
||
void immThemeColorShadeAlpha(int colorid, int coloffset, int alphaoffset);
|
||
|
||
#ifdef __cplusplus
|
||
}
|
||
#endif
|