如何调试GLSL着色器?


193

我需要调试GLSL程序,但是我不知道如何输出中间结果。是否可以使用GLSL进行一些调试跟踪(例如使用printf)?


6
...而无需使用glslDevil之类的外部软件。
弗兰克·弗赖堡

看看GLSL Fragment着色器中的float变量和文本的调试打印,您只需要单个备用纹理单元即可实现字体和打印区域中输出值的恒定状态
Spektre

Answers:


117

您无法轻松地从GLSL内部通讯回CPU。最好使用glslDevil或其他工具。

一个printf将需要尝试从运行GLSL代码的GPU返回到CPU。相反,您可以尝试推动显示。而不是尝试输出文本,而是输出屏幕上视觉上独特的内容。例如,仅当达到要添加printf的代码点时,才可以绘制特定颜色的东西。如果需要打印一个值,则可以根据该值设置颜色。


61
如果您要调试着色器的确切原因是什么都没有出现,该怎么办?
Jeroen

11
您为什么要调试任何东西?由于它的代码,他想检查的运行时间值,我大胆....
RichieHH

3
GLSL-Debugger是glslDevil的开源分支。
Magnus

@Magnus不再积极维护,仅支持GLSL最高1.20。
罗斯兰

57
void main(){
  float bug=0.0;
  vec3 tile=texture2D(colMap, coords.st).xyz;
  vec4 col=vec4(tile, 1.0);

  if(something) bug=1.0;

  col.x+=bug;

  gl_FragColor=col;
}

8
这是一个调试设备。例如,如果您想知道场景中的灯光位置,请转到:if(lpos.x> 100)bug = 1.0。如果灯光位置大于100,则场景将变为红色。
ste3e 2011年

12

我发现“ 变换反馈”是调试顶点着色器的有用工具。您可以使用它来捕获VS输出的​​值,并在CPU端读回它们,而无需通过光栅化器。

是有关“变换反馈”教程的另一个链接。


8

如果要在屏幕上可视化值的变化,可以使用与此类似的热图函数(我在hlsl中编写了该函数,但是很容易适应glsl):

float4 HeatMapColor(float value, float minValue, float maxValue)
{
    #define HEATMAP_COLORS_COUNT 6
    float4 colors[HEATMAP_COLORS_COUNT] =
    {
        float4(0.32, 0.00, 0.32, 1.00),
        float4(0.00, 0.00, 1.00, 1.00),
        float4(0.00, 1.00, 0.00, 1.00),
        float4(1.00, 1.00, 0.00, 1.00),
        float4(1.00, 0.60, 0.00, 1.00),
        float4(1.00, 0.00, 0.00, 1.00),
    };
    float ratio=(HEATMAP_COLORS_COUNT-1.0)*saturate((value-minValue)/(maxValue-minValue));
    float indexMin=floor(ratio);
    float indexMax=min(indexMin+1,HEATMAP_COLORS_COUNT-1);
    return lerp(colors[indexMin], colors[indexMax], ratio-indexMin);
}

然后在像素着色器中,您只输出类似以下内容的内容:

return HeatMapColor(myValue, 0.00, 50.00);

并可以了解像素之间的差异:

在此处输入图片说明

当然,您可以使用任何喜欢的颜色集。



4

您可以尝试以下方法:https : //github.com/msqrt/shader-printf,这是一个被称为“ GLSL的简单printf功能”的实现。

您可能还想尝试ShaderToy,也许还可以从YouTube的“ The Art of Code” YouTube频道观看类似该视频(https://youtu.be/EBrAdahFtuo)的视频,在该视频中,您可以看到一些对调试和调试非常有用的技术。可视化。我可以强烈推荐他的频道,因为他写了一些非常不错的文章,并且他也有技巧以新颖,引人入胜且易于理解的格式展示复杂的想法(他的Mandelbrot视频就是一个很好的例子:https:// youtu.be/6IWXkV82oyY

我希望没有人会介意这个较晚的答复,但是这个问题在Google搜索GLSL调试中的排名很高,而且在9年中当然有了很多变化:-)

PS:其他替代方案也可能是NVIDIA nSight和AMD ShaderAnalyzer,它们为着色器提供了完整的步进调试器。


2

我正在分享一个片段着色器示例,我如何实际调试。

#version 410 core

uniform sampler2D samp;
in VS_OUT
{
    vec4 color;
    vec2 texcoord;
} fs_in;

out vec4 color;

void main(void)
{
    vec4 sampColor;
    if( texture2D(samp, fs_in.texcoord).x > 0.8f)  //Check if Color contains red
        sampColor = vec4(1.0f, 1.0f, 1.0f, 1.0f);  //If yes, set it to white
    else
        sampColor = texture2D(samp, fs_in.texcoord); //else sample from original
    color = sampColor;

}

在此处输入图片说明


2

该答案的底部是GLSL代码的示例,该代码允许将完整float值输出为颜色,并编码IEEE 754 binary32。我按如下方式使用它(此片段给出了yymodelview矩阵的组成部分):

vec4 xAsColor=toColor(gl_ModelViewMatrix[1][1]);
if(bool(1)) // put 0 here to get lowest byte instead of three highest
    gl_FrontColor=vec4(xAsColor.rgb,1);
else
    gl_FrontColor=vec4(xAsColor.a,0,0,1);

将其显示在屏幕上之后,您可以使用任何颜色选择器,将颜色设置为HTML格式(如果不需要更高的精度,则追加00到该rgb值,如果需要,则进行第二遍以获取较低的字节),并且您将得到floatIEEE 754 的十六进制表示形式binary32

这是的实际实现toColor()

const int emax=127;
// Input: x>=0
// Output: base 2 exponent of x if (x!=0 && !isnan(x) && !isinf(x))
//         -emax if x==0
//         emax+1 otherwise
int floorLog2(float x)
{
    if(x==0.) return -emax;
    // NOTE: there exist values of x, for which floor(log2(x)) will give wrong
    // (off by one) result as compared to the one calculated with infinite precision.
    // Thus we do it in a brute-force way.
    for(int e=emax;e>=1-emax;--e)
        if(x>=exp2(float(e))) return e;
    // If we are here, x must be infinity or NaN
    return emax+1;
}

// Input: any x
// Output: IEEE 754 biased exponent with bias=emax
int biasedExp(float x) { return emax+floorLog2(abs(x)); }

// Input: any x such that (!isnan(x) && !isinf(x))
// Output: significand AKA mantissa of x if !isnan(x) && !isinf(x)
//         undefined otherwise
float significand(float x)
{
    // converting int to float so that exp2(genType) gets correctly-typed value
    float expo=float(floorLog2(abs(x)));
    return abs(x)/exp2(expo);
}

// Input: x\in[0,1)
//        N>=0
// Output: Nth byte as counted from the highest byte in the fraction
int part(float x,int N)
{
    // All comments about exactness here assume that underflow and overflow don't occur
    const float byteShift=256.;
    // Multiplication is exact since it's just an increase of exponent by 8
    for(int n=0;n<N;++n)
        x*=byteShift;

    // Cut higher bits away.
    // $q \in [0,1) \cap \mathbb Q'.$
    float q=fract(x);

    // Shift and cut lower bits away. Cutting lower bits prevents potentially unexpected
    // results of rounding by the GPU later in the pipeline when transforming to TrueColor
    // the resulting subpixel value.
    // $c \in [0,255] \cap \mathbb Z.$
    // Multiplication is exact since it's just and increase of exponent by 8
    float c=floor(byteShift*q);
    return int(c);
}

// Input: any x acceptable to significand()
// Output: significand of x split to (8,8,8)-bit data vector
ivec3 significandAsIVec3(float x)
{
    ivec3 result;
    float sig=significand(x)/2.; // shift all bits to fractional part
    result.x=part(sig,0);
    result.y=part(sig,1);
    result.z=part(sig,2);
    return result;
}

// Input: any x such that !isnan(x)
// Output: IEEE 754 defined binary32 number, packed as ivec4(byte3,byte2,byte1,byte0)
ivec4 packIEEE754binary32(float x)
{
    int e = biasedExp(x);
    // sign to bit 7
    int s = x<0. ? 128 : 0;

    ivec4 binary32;
    binary32.yzw=significandAsIVec3(x);
    // clear the implicit integer bit of significand
    if(binary32.y>=128) binary32.y-=128;
    // put lowest bit of exponent into its position, replacing just cleared integer bit
    binary32.y+=128*int(mod(float(e),2.));
    // prepare high bits of exponent for fitting into their positions
    e/=2;
    // pack highest byte
    binary32.x=e+s;

    return binary32;
}

vec4 toColor(float x)
{
    ivec4 binary32=packIEEE754binary32(x);
    // Transform color components to [0,1] range.
    // Division is inexact, but works reliably for all integers from 0 to 255 if
    // the transformation to TrueColor by GPU uses rounding to nearest or upwards.
    // The result will be multiplied by 255 back when transformed
    // to TrueColor subpixel value by OpenGL.
    return vec4(binary32)/255.;
}

1

对纹理进行脱机渲染并评估纹理的数据。您可以通过谷歌搜索“渲染到纹理” opengl来找到相关代码,然后使用glReadPixels将输出读取到数组中并对其进行断言(因为在调试器中查看如此大的数组通常并没有真正的用处)。

另外,您可能想禁用钳位以输出不介于0和1之间的值,仅浮点纹理支持该

亲自调试着色器一段时间会困扰我。似乎没有一个好的方法-如果有人找到了一个好的(而不是过时的/过时的)调试器,请告诉我。


3
任何说“ google xyz”的答案或评论都应从Stackoverflow上禁止或投弃权票。
gregoiregentil

1

现有的答案都是好东西,但我想分享一小块宝石,这对于调试GLSL着色器中棘手的精度问题很有用。由于将非常大的整数表示为浮点,因此需要谨慎使用floor(n)和floor(n + 0.5)来将round()实现为精确的int。然后,可以通过以下逻辑渲染一个精确的int浮点值,以将字节分量打包为R,G和B输出值。

  // Break components out of 24 bit float with rounded int value
  // scaledWOB = (offset >> 8) & 0xFFFF
  float scaledWOB = floor(offset / 256.0);
  // c2 = (scaledWOB >> 8) & 0xFF
  float c2 = floor(scaledWOB / 256.0);
  // c0 = offset - (scaledWOB << 8)
  float c0 = offset - floor(scaledWOB * 256.0);
  // c1 = scaledWOB - (c2 << 8)
  float c1 = scaledWOB - floor(c2 * 256.0);

  // Normalize to byte range
  vec4 pix;  
  pix.r = c0 / 255.0;
  pix.g = c1 / 255.0;
  pix.b = c2 / 255.0;
  pix.a = 1.0;
  gl_FragColor = pix;
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.