Skip to content

tr_image: rework some builtin images #1804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Sep 26, 2025
Merged

tr_image: rework some builtin images #1804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3bb4521
tr_image: resize builtin images as 1×1
illwieckz Sep 14, 2025
774dee4
renderer: simplify builtin color image name parsing, rename as $name,…
illwieckz Sep 14, 2025
b2e519d
tr_image: rename framebuffer images as *name
illwieckz Sep 15, 2025
2707d5a
tr_image: rename remaining builtin images as $name
illwieckz Sep 15, 2025
81e88e7
tr_image: extend internal image detection
illwieckz Sep 15, 2025
d802326
tr_image: do not rely on previously set data for cinematic, numberize…
illwieckz Sep 8, 2025
bc0107e
tr_image: rename generated textures as *name
illwieckz Sep 16, 2025
7e9cf88
tr_image: make the $black builtin image opaque
illwieckz Sep 17, 2025
08c8c41
tr_image: NUKE the $red, $green and $blue builtin images
illwieckz Sep 17, 2025
1d93ff3
tr_image: drop the _name builtin image detection as this convention i…
illwieckz Sep 26, 2025
0fbfbd1
tr_image: add comment about image *name and $name
illwieckz Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 37 additions & 59 deletions src/engine/renderer/tr_image.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1819,11 +1819,18 @@ image_t *R_FindImageFile( const char *imageName, imageParams_t &imageParams )
}

// Built-in images can't be reloaded with different parameters, so return them as-is.
// For most of the usable ones e.g. _white, parameters wouldn't make a difference anyway.
// HACK: detect built-in images by naming convention, though nothing stops users from using such names
if ( image->name[ 0 ] == '_' && !strchr( image->name, '/' ) )
// For most of the usable ones e.g. $white, parameters wouldn't make a difference anyway.
// Detect built-in images by naming convention.
switch ( image->name[ 0 ] )
{
return image;
// Private images not meant to be reused (like framebuffers, UI-generated images…).
case '*':
// Public images reusable by the user, like $white that can be used in .shader files.
case '$':
return image;
break;
default:
break;
}

bool compatible = false;
Expand Down Expand Up @@ -2383,7 +2390,7 @@ static void R_CreateDefaultImage()
imageParams.filterType = filterType_t::FT_DEFAULT;
imageParams.wrapType = wrapTypeEnum_t::WT_REPEAT;

tr.defaultImage = R_CreateImage( "_default", ( const byte ** ) &dataPtr, DEFAULT_SIZE, DEFAULT_SIZE, 1, imageParams );
tr.defaultImage = R_CreateImage( "$default", ( const byte ** ) &dataPtr, DEFAULT_SIZE, DEFAULT_SIZE, 1, imageParams );
}

static void R_CreateContrastRenderFBOImage()
Expand All @@ -2401,7 +2408,7 @@ static void R_CreateContrastRenderFBOImage()
imageParams.filterType = filterType_t::FT_LINEAR;
imageParams.wrapType = wrapTypeEnum_t::WT_CLAMP;

tr.contrastRenderFBOImage = R_CreateImage( "_contrastRenderFBO", nullptr, width, height, 1, imageParams );
tr.contrastRenderFBOImage = R_CreateImage( "*contrastRenderFBO", nullptr, width, height, 1, imageParams );
}

static void R_CreateBloomRenderFBOImages()
Expand All @@ -2421,7 +2428,7 @@ static void R_CreateBloomRenderFBOImages()
imageParams.filterType = filterType_t::FT_LINEAR;
imageParams.wrapType = wrapTypeEnum_t::WT_CLAMP;

tr.bloomRenderFBOImage[i] = R_CreateImage( va( "_bloomRenderFBO%d", i ), nullptr, width, height, 1, imageParams );
tr.bloomRenderFBOImage[i] = R_CreateImage( va( "*bloomRenderFBO%d", i ), nullptr, width, height, 1, imageParams );
}
}

Expand Down Expand Up @@ -2456,15 +2463,15 @@ static void R_CreateCurrentRenderImage()
imageParams.filterType = filterType_t::FT_NEAREST;
imageParams.wrapType = wrapTypeEnum_t::WT_CLAMP;

tr.currentRenderImage[0] = R_CreateImage( "_currentRender[0]", nullptr, width, height, 1, imageParams );
tr.currentRenderImage[1] = R_CreateImage( "_currentRender[1]", nullptr, width, height, 1, imageParams );
tr.currentRenderImage[0] = R_CreateImage( "*currentRender0", nullptr, width, height, 1, imageParams );
tr.currentRenderImage[1] = R_CreateImage( "*currentRender1", nullptr, width, height, 1, imageParams );

imageParams = {};
imageParams.bits = IF_NOPICMIP | IF_PACKED_DEPTH24_STENCIL8;
imageParams.filterType = filterType_t::FT_NEAREST;
imageParams.wrapType = wrapTypeEnum_t::WT_CLAMP;

tr.currentDepthImage = R_CreateImage( "_currentDepth", nullptr, width, height, 1, imageParams );
tr.currentDepthImage = R_CreateImage( "*currentDepth", nullptr, width, height, 1, imageParams );

if ( glConfig.usingMaterialSystem ) {
materialSystem.GenerateDepthImages( width, height, imageParams );
Expand Down Expand Up @@ -2494,18 +2501,18 @@ static void R_CreateDepthRenderImage()
imageParams.bits = IF_NOPICMIP;
imageParams.bits |= r_highPrecisionRendering.Get() ? IF_TWOCOMP32F : IF_TWOCOMP16F;

tr.depthtile1RenderImage = R_CreateImage( "_depthtile1Render", nullptr, w, h, 1, imageParams );
tr.depthtile1RenderImage = R_CreateImage( "*depthtile1Render", nullptr, w, h, 1, imageParams );

w = (width + TILE_SIZE - 1) >> TILE_SHIFT;
h = (height + TILE_SIZE - 1) >> TILE_SHIFT;

imageParams.wrapType = wrapTypeEnum_t::WT_CLAMP;

tr.depthtile2RenderImage = R_CreateImage( "_depthtile2Render", nullptr, w, h, 1, imageParams );
tr.depthtile2RenderImage = R_CreateImage( "*depthtile2Render", nullptr, w, h, 1, imageParams );

imageParams.bits = IF_NOPICMIP | IF_RGBA32UI;

tr.lighttileRenderImage = R_Create3DImage( "_lighttileRender", nullptr, w, h, glConfig.realtimeLightLayers, imageParams );
tr.lighttileRenderImage = R_Create3DImage( "*lighttileRender", nullptr, w, h, glConfig.realtimeLightLayers, imageParams );
}
}

Expand All @@ -2526,7 +2533,7 @@ static void R_CreatePortalRenderImage()
imageParams.filterType = filterType_t::FT_NEAREST;
imageParams.wrapType = wrapTypeEnum_t::WT_CLAMP;

tr.portalRenderImage = R_CreateImage( "_portalRender", nullptr, width, height, 1, imageParams );
tr.portalRenderImage = R_CreateImage( "*portalRender", nullptr, width, height, 1, imageParams );
}

// *INDENT-OFF*
Expand All @@ -2546,7 +2553,7 @@ static void R_CreateBlackCubeImage()
imageParams.wrapType = wrapTypeEnum_t::WT_EDGE_CLAMP;

const byte *dataPtrs[ 6 ] = { data, data, data, data, data, data };
tr.blackCubeImage = R_CreateCubeImage( "_blackCube", dataPtrs, width, height, imageParams );
tr.blackCubeImage = R_CreateCubeImage( "$blackCube", dataPtrs, width, height, imageParams );
}

// *INDENT-ON*
Expand All @@ -2572,7 +2579,7 @@ static void R_CreateWhiteCubeImage()
imageParams.filterType = filterType_t::FT_LINEAR;
imageParams.wrapType = wrapTypeEnum_t::WT_EDGE_CLAMP;

tr.whiteCubeImage = R_CreateCubeImage( "_whiteCube", ( const byte ** ) data, width, height, imageParams );
tr.whiteCubeImage = R_CreateCubeImage( "$whiteCube", ( const byte ** ) data, width, height, imageParams );

for ( i = 5; i >= 0; i-- )
{
Expand Down Expand Up @@ -2615,7 +2622,7 @@ static void R_CreateColorGradeImage()
imageParams.filterType = filterType_t::FT_LINEAR;
imageParams.wrapType = wrapTypeEnum_t::WT_EDGE_CLAMP;

tr.colorGradeImage = R_Create3DImage( "_colorGrade", data, REF_COLORGRADEMAP_SIZE, REF_COLORGRADEMAP_SIZE, REF_COLORGRADE_SLOTS * REF_COLORGRADEMAP_SIZE, imageParams );
tr.colorGradeImage = R_Create3DImage( "$colorGrade", data, REF_COLORGRADEMAP_SIZE, REF_COLORGRADEMAP_SIZE, REF_COLORGRADE_SLOTS * REF_COLORGRADEMAP_SIZE, imageParams );

ri.Hunk_FreeTempMemory( data );
}
Expand All @@ -2627,11 +2634,8 @@ R_CreateBuiltinImages
*/
void R_CreateBuiltinImages()
{
constexpr int DIMENSION = 8;
int x;
byte data[ DIMENSION * DIMENSION * 4 ];
byte data[ 1 * 1 * 4 ];
byte *dataPtr = data;
byte *out;

R_CreateDefaultImage();

Expand All @@ -2643,57 +2647,31 @@ void R_CreateBuiltinImages()
imageParams.filterType = filterType_t::FT_LINEAR;
imageParams.wrapType = wrapTypeEnum_t::WT_REPEAT;

tr.whiteImage = R_CreateImage( "_white", ( const byte ** ) &dataPtr, DIMENSION, DIMENSION, 1, imageParams );
tr.whiteImage = R_CreateImage( "$white", ( const byte ** ) &dataPtr, 1, 1, 1, imageParams );

// we use a solid black image instead of disabling texturing
memset( data, 0, sizeof( data ) );
tr.blackImage = R_CreateImage( "_black", ( const byte ** ) &dataPtr, DIMENSION, DIMENSION, 1, imageParams );

// red
for ( x = DIMENSION * DIMENSION, out = data; x; --x, out += 4 )
{
out[ 1 ] = out[ 2 ] = 0;
out[ 0 ] = out[ 3 ] = 255;
}

tr.redImage = R_CreateImage( "_red", ( const byte ** ) &dataPtr, DIMENSION, DIMENSION, 1, imageParams );
Vector4Set( data, 0, 0, 0, 255 );

// green
for ( x = DIMENSION * DIMENSION, out = data; x; --x, out += 4 )
{
out[ 0 ] = out[ 2 ] = 0;
out[ 1 ] = out[ 3 ] = 255;
}

tr.greenImage = R_CreateImage( "_green", ( const byte ** ) &dataPtr, DIMENSION, DIMENSION, 1, imageParams );

// blue
for ( x = DIMENSION * DIMENSION, out = data; x; --x, out += 4 )
{
out[ 0 ] = out[ 1 ] = 0;
out[ 2 ] = out[ 3 ] = 255;
}

tr.blueImage = R_CreateImage( "_blue", ( const byte ** ) &dataPtr, DIMENSION, DIMENSION, 1, imageParams );
tr.blackImage = R_CreateImage( "$black", ( const byte ** ) &dataPtr, 1, 1, 1, imageParams );

// generate a default normalmap with a fully opaque heightmap (no displacement)
for ( x = DIMENSION * DIMENSION, out = data; x; --x, out += 4 )
{
out[ 0 ] = out[ 1 ] = 128;
out[ 2 ] = 255;
out[ 3 ] = 255;
}
Vector4Set( data, 128, 128, 255, 255 );

imageParams.bits = IF_NOPICMIP | IF_NORMALMAP;

tr.flatImage = R_CreateImage( "_flat", ( const byte ** ) &dataPtr, DIMENSION, DIMENSION, 1, imageParams );
tr.flatImage = R_CreateImage( "$flat", ( const byte ** ) &dataPtr, 1, 1, 1, imageParams );

imageParams.bits = IF_NOPICMIP;
imageParams.wrapType = wrapTypeEnum_t::WT_CLAMP;

// Don't reuse previously set data, we test the values for selecting the upload format.
memset( data, 255, sizeof( data ) );

size_t numCinematicImages = 0;
for ( image_t * &image : tr.cinematicImage )
{
image = R_CreateImage( "_cinematic", ( const byte ** ) &dataPtr, 1, 1, 1, imageParams );
std::string name = Str::Format( "*cinematic%d", numCinematicImages++ );
image = R_CreateImage( name.c_str(), ( const byte ** ) &dataPtr, 1, 1, 1, imageParams );
}

R_CreateContrastRenderFBOImage();
Expand Down Expand Up @@ -2855,7 +2833,7 @@ qhandle_t RE_GenerateTexture( const byte *pic, int width, int height )
{
R_SyncRenderThread();

std::string name = Str::Format( "$generatedTexture%d", tr.numGeneratedTextures++ );
std::string name = Str::Format( "*generatedTexture%d", tr.numGeneratedTextures++ );

imageParams_t imageParams = {};
imageParams.bits = IF_NOPICMIP;
Expand Down
5 changes: 1 addition & 4 deletions src/engine/renderer/tr_local.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2445,10 +2445,7 @@ enum
image_t *defaultImage;
image_t *cinematicImage[ MAX_IN_GAME_VIDEOS ];
image_t *whiteImage; // full of 0xff
image_t *blackImage; // full of 0x0
image_t *redImage;
image_t *greenImage;
image_t *blueImage;
image_t *blackImage; // 0x0 color channels, 0xff alpha channel
image_t *flatImage; // use this as default normalmap
image_t *blackCubeImage;
image_t *whiteCubeImage;
Expand Down
15 changes: 5 additions & 10 deletions src/engine/renderer/tr_shader.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1429,24 +1429,19 @@ static bool LoadMap( shaderStage_t *stage, const char *buffer, stageType_t type,
return true;
}

if ( !Q_stricmp( token, "$whiteimage" ) || !Q_stricmp( token, "$white" ) || !Q_stricmp( token, "_white" ) ||
!Q_stricmp( token, "*white" ) )
// Quake III backward compatibility.
if ( !Q_stricmp( token, "$whiteimage" ) || !Q_stricmp( token, "*white" ) )
{
stage->bundle[ bundleIndex ].image[ 0 ] = tr.whiteImage;
return true;
}
else if ( !Q_stricmp( token, "$blackimage" ) || !Q_stricmp( token, "$black" ) || !Q_stricmp( token, "_black" ) ||
!Q_stricmp( token, "*black" ) )

// Other engine compatibility (old XeaL, QFusion…)
if ( !Q_stricmp( token, "$blackimage" ) || !Q_stricmp( token, "*black" ) )
{
stage->bundle[ bundleIndex ].image[ 0 ] = tr.blackImage;
return true;
}
else if ( !Q_stricmp( token, "$flatimage" ) || !Q_stricmp( token, "$flat" ) || !Q_stricmp( token, "_flat" ) ||
!Q_stricmp( token, "*flat" ) )
{
stage->bundle[ bundleIndex ].image[ 0 ] = tr.flatImage;
return true;
}

else if ( !Q_stricmp( token, "$lightmap" ) )
{
Expand Down