Hyper: Created page with "{{Notice|type=warn|content=This list is a work in progress!}} = RenderAction = These functions are provided for `Sonicteam::RenderAction` procedures. === Pixel Formats === {| class="wikitable" |+ !Name !Description |- |A8R8G8B8 |Used for 8-bit buffers (32bpp). |- |A16B16G16R16F |Used for 16-bit floating point buffers (64bpp). |- |A32B32G32R32F |Used for 32-bit floating point buffers (128bpp). |- |HDR |Used for bloom buffers. |- |R32F |Used for single channel..."

2026-04-14T15:25:22Z

Created page with "{{Notice|type=warn|content=This list is a work in progress!}} = RenderAction = These functions are provided for <code>Sonicteam::RenderAction</code> procedures. === Pixel Formats === {| class="wikitable" |+ !Name !Description |- |A8R8G8B8 |Used for 8-bit buffers (32bpp). |- |A16B16G16R16F |Used for 16-bit floating point buffers (64bpp). |- |A32B32G32R32F |Used for 32-bit floating point buffers (128bpp). |- |HDR |Used for bloom buffers. |- |R32F |Used for single channel..."

New page

{{Notice|type=warn|content=This list is a work in progress!}}
= RenderAction =
These functions are provided for <code>Sonicteam::RenderAction</code> procedures.

=== Pixel Formats ===
{| class="wikitable"
|+
!Name
!Description
|-
|A8R8G8B8
|Used for 8-bit buffers (32bpp).
|-
|A16B16G16R16F
|Used for 16-bit floating point buffers (64bpp).
|-
|A32B32G32R32F
|Used for 32-bit floating point buffers (128bpp).
|-
|HDR
|Used for bloom buffers.
|-
|R32F
|Used for single channel 32-bit floating point buffers (32bpp).
|-
|D24S8
|Used for 24-bit depth and 8-bit stencil buffers (32bpp).
|-
|D24FS8
|Used for 24-bit floating point depth and 8-bit stencil buffers (32bpp).
|}

=== Surface Buffers ===
{| class="wikitable"
|+
!Name
!Description
|-
|backbuffer
|N/A
|-
|framebuffer0
|N/A
|-
|framebuffer1
|N/A
|-
|framebuffer_hdr
|N/A
|-
|framebuffer_tile
|N/A
|-
|framebuffer_1_4_0
|N/A
|-
|framebuffer_1_4_1
|N/A
|-
|framebuffer_1_8_0
|N/A
|-
|framebuffer_1_8_1
|N/A
|-
|framebuffer_1_16_0
|N/A
|-
|framebuffer_1_16_1
|N/A
|-
|framebuffer_1_32_0
|N/A
|-
|framebuffer_1_32_1
|N/A
|-
|depthstencil_1_4
|N/A
|}

=== Render Targets ===
{| class="wikitable"
|+
!Name
!Description
|-
|none
|N/A
|-
|color_depth
|N/A
|-
|color
|N/A
|-
|depth
|N/A
|-
|stencil
|N/A
|-
|depthstencil
|N/A
|-
|all
|N/A
|}

== CreateSurface ==

{{Notice|type=warn|content=This function is unused and has not been tested, information regarding it may be inaccurate.}}
=== Description ===
Creates a surface.

=== Signature ===
CreateSurface(ptr, name, width, height, format)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|ptr
|Pointer
|A pointer to a structure for accessing rendering structures.
|✔️
|-
|name
|String
|The name of the surface.
|✔️
|-
|width
|Number
|The width of the surface.
|✔️
|-
|height
|Number
|The height of the surface.
|✔️
|-
|format
|String
|The format of the surface. See [[#Pixel Formats|Pixel Formats]].
|✔️
|}

=== Results ===
None.

== CreateTexture ==

=== Description ===
Creates a texture.

=== Signature ===
CreateTexture(ptr, name, width, height, unknown, format)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|ptr
|Pointer
|A pointer to a structure for accessing rendering structures.
|✔️
|-
|name
|String
|The name of the texture.
|✔️
|-
|width
|Number
|The width of the texture.
|✔️
|-
|height
|Number
|The height of the texture.
|✔️
|-
|unknown
|Number
|Unknown.
|✔️
|-
|format
|String
|The format of the texture. See [[#Pixel Formats|Pixel Formats]].
|✔️
|}

=== Results ===
None.

== CreateCubeTexture ==

=== Description ===
Creates an array of six textures for each face of a cube map.

=== Signature ===
CreateCubeTexture(ptr, name, size, unknown, format)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|ptr
|Pointer
|A pointer to a structure for accessing rendering structures.
|✔️
|-
|name
|String
|The name of the texture array.
|✔️
|-
|size
|Number
|The size of the textures.
|✔️
|-
|unknown
|Number
|Unknown.
|✔️
|-
|format
|String
|The format of the texture. See [[#Pixel Formats|Pixel Formats]].
|✔️
|}

=== Results ===
None.

== CreateArrayTexture ==

=== Description ===
Creates an array of textures.

=== Signature ===
CreateArrayTexture(ptr, name, width, height, count, format)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|ptr
|Pointer
|A pointer to a structure for accessing rendering structures.
|✔️
|-
|name
|String
|The name of the texture array.
|✔️
|-
|width
|Number
|The width of the textures.
|✔️
|-
|height
|Number
|The height of the textures.
|✔️
|-
|count
|Number
|The number of textures in the array.
|✔️
|-
|format
|String
|The format of the textures. See [[#Pixel Formats|Pixel Formats]].
|✔️
|}

=== Results ===
None.

== CreateDepthStencilSurface ==

=== Description ===
Creates a depth stencil surface.

=== Signature ===
CreateDepthStencilSurface(ptr, name, width, height, format)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|ptr
|Pointer
|A pointer to a structure for accessing rendering structures.
|✔️
|-
|name
|String
|The name of the surface. See [[#Surface Buffers|Surface Buffers]].
|✔️
|-
|width
|Number
|The width of the surface.
|✔️
|-
|height
|Number
|The height of the surface.
|✔️
|-
|format
|String
|The format of the surface. See [[#Pixel Formats|Pixel Formats]].
|✔️
|}

=== Results ===
None.

== LoadTexture ==

=== Description ===
Loads a texture.

=== Signature ===
LoadTexture(ptr, path, name)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|ptr
|Pointer
|A pointer to a structure for accessing rendering structures.
|✔️
|-
|path
|String
|The path to the texture.
|✔️
|-
|name
|String
|The name of the texture.
|✔️
|}

=== Results ===
None.

== SetLabel ==

{{Notice|type=warn|content=This function is unused and has not been tested, information regarding it may be inaccurate.}}
=== Description ===
Unknown.

=== Signature ===
SetLabel(ptr, name)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|ptr
|Pointer
|A pointer to a structure for accessing rendering structures.
|✔️
|-
|name
|String
|The name of the label.
|✔️
|}

=== Results ===
None.

== BeginBlock ==

=== Description ===
Begins an operation block.

=== Signature ===
BeginBlock(ptr, name, command)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|ptr
|Pointer
|A pointer to a structure for accessing rendering structures.
|✔️
|-
|name
|String
|The name of the block.
|✔️
|-
|command
|String
|The command of the block.
|✔️
|}

==== Commands ====
{| class="wikitable"
|+
!Name
!Description
|-
|run
|N/A
|-
|stop
|N/A
|}

=== Results ===
None.

== EndBlock ==

=== Description ===
Ends an operation block.

=== Signature ===
EndBlock(ptr)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|ptr
|Pointer
|A pointer to a structure for accessing rendering structures.
|✔️
|}

=== Results ===
None.

== ResetRenderStates ==

{{Notice|type=warn|content=This function is unused and has not been tested, information regarding it may be inaccurate.}}
=== Description ===
Unknown.

=== Signature ===
ResetRenderStates(ptr)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|ptr
|Pointer
|A pointer to a structure for accessing rendering structures.
|✔️
|}

=== Results ===
None.

== SetFrameBufferObject ==

=== Description ===
Unknown.

=== Signature ===
SetFrameBufferObject(ptr, name, buffer_name, render_target, x, y, z, w)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|ptr
|Pointer
|A pointer to a structure for accessing rendering structures.
|✔️
|-
|name
|String
|The name of the object.
|✔️
|-
|buffer_name
|String
|The name of the buffer.
|✔️
|-
|render_target
|String
|The render target. See [[#Render Targets|Render Targets]].
|✔️
|-
|x
|Number
|Implementation-specific.
|✔️
|-
|y
|Number
|Implementation-specific.
|✔️
|-
|z
|Number
|Implementation-specific.
|✔️
|-
|w
|Number
|Implementation-specific.
|✔️
|}

=== Results ===
None.

== SetFrameBufferObjectOnce ==

=== Description ===
Unknown.

=== Signature ===
SetFrameBufferObjectOnce(ptr, name, buffer_name, render_target, x, y, z, w)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|ptr
|Pointer
|A pointer to a structure for accessing rendering structures.
|✔️
|-
|name
|String
|The name of the object.
|✔️
|-
|buffer_name
|String
|The name of the buffer.
|✔️
|-
|render_target
|String
|The render target. See [[#Render Targets|Render Targets]].
|✔️
|-
|x
|Number
|Implementation-specific.
|✔️
|-
|y
|Number
|Implementation-specific.
|✔️
|-
|z
|Number
|Implementation-specific.
|✔️
|-
|w
|Number
|Implementation-specific.
|✔️
|}

=== Results ===
None.

== ClearRenderTarget ==

=== Description ===
Unknown.

=== Signature ===
ClearRenderTarget(ptr, render_target, x, y, z, w)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|ptr
|Pointer
|A pointer to a structure for accessing rendering structures.
|✔️
|-
|render_target
|String
|The render target. See [[#Render Targets|Render Targets]].
|✔️
|-
|x
|Number
|Implementation-specific.
|✔️
|-
|y
|Number
|Implementation-specific.
|✔️
|-
|z
|Number
|Implementation-specific.
|✔️
|-
|w
|Number
|Implementation-specific.
|✔️
|}

=== Results ===
None.

== SetColorWriteEnable ==

=== Description ===
Unknown.

=== Signature ===
SetColorWriteEnable(ptr, unknown, r, g, b, a)

==== Parameters ====
{| class="wikitable"
|+
!Parameter
!Type
!Description
!Required?
|-
|ptr
|Pointer
|A pointer to a structure for accessing rendering structures.
|✔️
|-
|unknown
|Number
|Unknown. Always zero.
|✔️
|-
|r
|Number
|Determines whether writing to the red channel is enabled.
|✔️
|-
|g
|Number
|Determines whether writing to the green channel is enabled.
|✔️
|-
|b
|Number
|Determines whether writing to the blue channel is enabled.
|✔️
|-
|a
|Number
|Determines whether writing to the alpha channel is enabled.
|✔️
|}

=== Results ===
None.

== SetViewport ==

== ResetViewport ==

== SetScissorTest ==

== SetScissorRect ==

== ResetScissorRect ==

== AutoSetAspect ==

== SetCullMode ==

== LockCullMode ==

== SetZMode ==

== LockZMode ==

== SetBlendMode ==

== LockBlendMode ==

== SetStencilEnable ==

== SetStencilOp ==

== SetBackStencilOp ==

== SetStencilFunc ==

== SetStencilWriteMask ==

== ApplyDevice ==

== CopyTexture ==

== Capture ==

== Resolve ==

== ApplySceneParams ==

== SetClip ==

== SetScreen ==

== SetFovY ==

== SetUserClipPlaneEnable ==

== SetTexture ==

== SetDepthTextures ==

== SetCSMTextures ==

== SetReflectionTextures ==

== SetConstantShader ==

== ColorFill ==

== MakeBloom ==

== ApplyBloom ==

== Rasterize ==

== RasterizeBurnoutBlur ==

== RenderWorld ==

== RenderSpanverse ==

== RenderCSD ==

== RenderDebug3DFont ==

== RenderDebug ==

== RenderNeParticle ==

== RenderNeParticlePost ==

== RenderGE1Particle ==

== RenderPostprocess ==

== SetCurrentScreen ==

== SetCurrentCamera ==

== RenderMovie ==

== PrepareCalculateCSM ==

== SetAutoZPass ==

== CommandBufferBegin ==

== CommandBufferEnd ==

== CommandBufferSetFrameBuffer ==

== CommandBufferSetConstantShader ==

== CommandBufferRenderWorld ==

== CommandBufferRun ==

== SetShaderGPRAllocation ==

== IsDebug ==

== GetPlatform ==

== GetSurfaceWidth ==

== GetSurfaceHeight ==

== GetFrameBufferFormat ==

== GetDepthStencilFormat ==

== GetRegistry ==

== GetNumScreens ==

Sonic the Hedgehog (2006) RenderAction Functions - Revision history