This routines uses 2 destination surfaces. It triggers a backbuffer copy to one of its surfaces, and then copies the other surface to system memory. This hopefully will remove any CPU stalls due to the rect lock call since the buffer will already be in system memory when it is called.

Parameters

pDstARGBA8	Pointer to a buffer that will hold the captured frame (should be at least 4*dstWidth*dstHieght for RGBA surface).
destinationWidth	Width of the frame to copy.
destinationHeight	Height of the frame to copy.

Note

If dstWidth or dstHeight is larger than the current surface dimensions, the dimensions of the surface are used for the copy.

Copy a captured surface to a buffer.

Parameters

pDstARGBA8	Pointer to a buffer that will hold the captured frame (should be at least 4*dstWidth*dstHieght for RGBA surface).
destinationWidth	Width of the frame to copy.
destinationHeight	Height of the frame to copy.

Note

If dstWidth or dstHeight is larger than the current surface dimensions, the dimensions of the surface are used for the copy.

Creates an Interface to the public params container.

Returns

Created IShaderPublicParams interface.

Returns various Renderer Settings, see ERenderQueryTypes.

Parameters

Query	e.g. EFQ_GetShaderCombinations.
rInOut	Input/Output Parameter, depends on the query if written to/read from, or both.

Reloads file at any time the renderer feels to do so (no guarantees, but likely on next frame update).

Note

This function is is thread safe.

Creates array of all supported video formats (except low resolution formats).

Returns

Number of formats in memory.

Sums DIP counts for the EFSLIST_* passes that match the submitted mask. Compose the mask with bitwise arithmetic, use (1 << EFSLIST_*) per list. E.g. to sum general and transparent, pass in ( (1 << EFSLIST_GENERAL) | (1 << EFSLIST_TRANSP) ).

Note

For stats.

This routine initializes 2 destination surfaces for use by the CaptureFrameBufferFast routine. It also captures the current backbuffer into one of the created surfaces.

Parameters

bufferWidth	Width of capture buffer, on consoles the scaling is done on the GPU. Pass in 0 (the default) to use backbuffer dimensions.
bufferHeight	Height of capture buffer.

Returns

true if surfaces were created otherwise returns false.

Used for pausing timer related stuff. Example: For texture animations, and shader 'time' parameter.

Pins an occlusion buffer into CPU memory, from where it can be used until UnpinOcclusionBuffer is called. The occlusion buffer is of type 'float[CULL_SIZEX * CULL_SIZEY]', and contains non-linearized depth values from 0 (near) to 1 (far). While at least one client has a buffer pinned, all other clients are guaranteed to pin the same buffer. Note: This implies all pins have to be released at some point or all clients will forever be stuck with old data. (Un)pinning can be arbitrarily nested from any thread and will never block forward progress of the render thread or GPU. The function may fail (by returning nullptr) if no data is available, in which case you must not call UnpinOcclusionBuffer.

Projects to screen. Returns true if successful.

This routine registers a callback address that is called when a new frame is available.

Parameters

pCapture

Address of the ICaptureFrameListener object.

Returns

true if successful, otherwise false.

See also

r_ShowDynTextures

Take a screenshot and save it to a file

Returns

true on success

Set the window icon to be displayed on the output window. The parameter is the path to a DDS texture file to be used as the icon. For best results, pass a square power-of-two sized texture, with a mip-chain.

Stop renderer at the end of the frame. E.g. ensures the renderer is not holding a lock when crash handler is trying to take a screenshot.

This routine unregisters a callback address that was previously registered.

Parameters

pCapture

Address of the ICaptureFrameListener object to unregister.

Returns

true if successful, otherwise false.