Detailed Description

Exports for User.

Using this library in your project

Include the header file in your project:

#include <psp2/razor_hud.h>

razor_hud.h

Link the library to the executable:

SceRazorHud_stub

Load the required module:

sceSysmoduleLoadModule(SCE_SYSMODULE_RAZOR_HUD);

sceSysmoduleLoadModule

int sceSysmoduleLoadModule(SceSysmoduleModuleId id)

Load a module.

SCE_SYSMODULE_RAZOR_HUD

@ SCE_SYSMODULE_RAZOR_HUD

Razor HUD module.

Definition: sysmodule.h:37

Functions
	VITASDK_BUILD_ASSERT_EQ (0x28, SceRazorGpuLiveResultInfo)

	VITASDK_BUILD_ASSERT_EQ (8, SceRazorGpuLiveEntryHeader)

	VITASDK_BUILD_ASSERT_EQ (4, SceRazorGpuLiveEntryJobVertexValues1)

	VITASDK_BUILD_ASSERT_EQ (0xC, SceRazorGpuLiveEntryJobFragmentValues1)

	VITASDK_BUILD_ASSERT_EQ (0x10, SceRazorGpuLiveEntryJobVertexValues2)

	VITASDK_BUILD_ASSERT_EQ (0xC, SceRazorGpuLiveEntryJobFragmentValues2)

	VITASDK_BUILD_ASSERT_EQ (4, SceRazorGpuLiveEntryJobVertexValues3)

	VITASDK_BUILD_ASSERT_EQ (4, SceRazorGpuLiveEntryJobFragmentValues3)

	VITASDK_BUILD_ASSERT_EQ (0x54, SceRazorGpuLiveEntryJobValues)

	VITASDK_BUILD_ASSERT_EQ (0x80, SceRazorGpuLiveEntryJob)

	VITASDK_BUILD_ASSERT_EQ (0x18, SceRazorGpuLiveEntryParameterBuffer)

	VITASDK_BUILD_ASSERT_EQ (0x20, SceRazorGpuLiveEntryFrame)

int	sceRazorGpuLiveSetMetricsGroup (uint32_t metrics)
	Sets a metrics group to use for gpu live debugging. More...

int	sceRazorGpuLiveSetBuffer (void buffer, SceSize buf_size, SceRazorGpuLiveResultInfo results)
	Sets the buffer in which to store gpu live debugging results for the current frame. More...

int	sceRazorGpuLiveStart ()
	Starts gpu live debugging. More...

int	sceRazorGpuLiveStop ()
	Stops gpu live debugging. More...

Data Structure Documentation

◆ SceRazorGpuLiveResultInfo

struct SceRazorGpuLiveResultInfo

Data Fields
void *	result_data	Pointer to the raw data results entries.
SceSize	entry_count	Number of elements stored in the results buffer.
SceSize	overflow_count
SceSize	buffer_size	Size of the results buffer in bytes.
uint64_t	start_time	Start time of the results collection in microseconds.
uint64_t	end_time	End time of the results collection in microseconds.
uint32_t	metric_group	Metrics group used for the results.
int	reserved	Reserved data.

◆ SceRazorGpuLiveEntryHeader

struct SceRazorGpuLiveEntryHeader

Data Fields
uint16_t	entry_size	Entry size in bytes.
uint16_t	entry_type	Entry type (One of SceRazorLiveTraceMetricEntryType)
int	reserved	Reserved data.

◆ SceRazorGpuLiveEntryJobVertexValues1

struct SceRazorGpuLiveEntryJobVertexValues1

Data Fields
float	usse_vertex_processing_percent	USSE vertex processing percentage.

◆ SceRazorGpuLiveEntryJobFragmentValues1

struct SceRazorGpuLiveEntryJobFragmentValues1

Data Fields
float	usse_fragment_processing_percent	USSE fragment processing percentage.
float	usse_dependent_texture_reads_percent	USSE dependant texture reads requests percentage.
float	usse_non_dependent_texture_reads_percent	USSE non-dependant texture reads requests percentage.

◆ SceRazorGpuLiveEntryJobVertexValues2

struct SceRazorGpuLiveEntryJobVertexValues2

Data Fields
uint32_t	vdm_primitives_input_num	VDM input primitives number.
uint32_t	mte_primitives_output_num	MTE output primitives number.
uint32_t	vdm_vertices_input_num	VDM input vertices number.
uint32_t	mte_vertices_output_num	MTE output vertices number.

◆ SceRazorGpuLiveEntryJobFragmentValues2

struct SceRazorGpuLiveEntryJobFragmentValues2

Data Fields
uint32_t	rasterized_pixels_before_hsr_num	Number of rasterized pixels before Hidden Surface Removal.
uint32_t	rasterized_output_pixels_num	Number of rasterized pixels.
uint32_t	rasterized_output_samples_num	Number of rasterized samples.

◆ SceRazorGpuLiveEntryJobVertexValues3

struct SceRazorGpuLiveEntryJobVertexValues3

Data Fields
uint32_t	tiling_accelerated_mem_writes	Amount of tiling accelerated memory writes in bytes.

◆ SceRazorGpuLiveEntryJobFragmentValues3

struct SceRazorGpuLiveEntryJobFragmentValues3

Data Fields
uint32_t	isp_parameter_fetches_mem_reads	Amount of ISP parameter fetches memory reads in bytes.

◆ SceRazorGpuLiveEntryJobValues

struct SceRazorGpuLiveEntryJobValues

Data Fields
SceRazorGpuLiveEntryJobVertexValues1	vertex_values_type1	Values for a job of SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_VERTEX1 type.
SceRazorGpuLiveEntryJobFragmentValues1	fragment_values_type1	Values for a job of SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_FRAGMENT1 type.
SceRazorGpuLiveEntryJobVertexValues2	vertex_values_type2	Values for a job of SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_VERTEX2 type.
SceRazorGpuLiveEntryJobFragmentValues2	fragment_values_type2	Values for a job of SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_FRAGMENT2 type.
SceRazorGpuLiveEntryJobVertexValues3	vertex_values_type3	Values for a job of SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_VERTEX3 type.
SceRazorGpuLiveEntryJobFragmentValues3	fragment_values_type3	Values for a job of SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_FRAGMENT3 type.
int	reserved[8]	Reserved data.

◆ SceRazorGpuLiveEntryJob

struct SceRazorGpuLiveEntryJob

Data Fields
SceRazorGpuLiveEntryHeader	header	Distinguishing header for the entry.
uint64_t	start_time	Start time of the entry in microseconds.
uint64_t	end_time	End time of the entry in microseconds.
uint8_t	type	The type of the job (One of SceRazorLiveTraceMetricJobType)
int8_t	core	Core number on which the job got executed.
uint16_t	scene_index	Index of the scene in which the job got executed.
uint32_t	frame_number	Frame number in which the job got executed.
SceRazorGpuLiveEntryJobValues	job_values	Reported values by the job.
uint32_t	process_id	ID of the process which executed the job.
int	unk	Unknown data.

◆ SceRazorGpuLiveEntryParameterBuffer

struct SceRazorGpuLiveEntryParameterBuffer

Data Fields
SceRazorGpuLiveEntryHeader	header	Distinguishing header for the entry.
uint64_t	peak_usage_timestamp	Time of param buffer peak usage in microseconds.
uint32_t	peak_usage_value	Memory peak usage of the param buffer in bytes.
uint8_t	partial_render	Flag indicating wether a partial render occurred or not.
uint8_t	vertex_job_paused	Flag indicating wether a vertex job had been paused or not.

◆ SceRazorGpuLiveEntryFrame

struct SceRazorGpuLiveEntryFrame

Data Fields
SceRazorGpuLiveEntryHeader	header	Distinguishing header for the entry.
uint64_t	start_time	Start time of the entry in microseconds.
uint32_t	duration	Duration of the frame in microseconds.
uint32_t	frame_number	Number of the frame.
uint32_t	gpu_activity_duration_time	Duration of GPU activity for the frame in microseconds.
int	reserved	Reserved data.

Enumeration Type Documentation

◆ SceRazorGpuLiveMetricsGroup

enum SceRazorGpuLiveMetricsGroup

Enumeration for the gpu live metrics groups.

Enumerator
SCE_RAZOR_GPU_LIVE_METRICS_GROUP_PBUFFER_USAGE
SCE_RAZOR_GPU_LIVE_METRICS_GROUP_OVERVIEW_1
SCE_RAZOR_GPU_LIVE_METRICS_GROUP_OVERVIEW_2
SCE_RAZOR_GPU_LIVE_METRICS_GROUP_OVERVIEW_3

◆ SceRazorLiveTraceMetricEntryType

enum SceRazorLiveTraceMetricEntryType

Enumeration for the gpu live results entry types.

Enumerator
SCE_RAZOR_LIVE_TRACE_METRIC_ENTRY_TYPE_JOB
SCE_RAZOR_LIVE_TRACE_METRIC_ENTRY_TYPE_PARAMETER_BUFFER
SCE_RAZOR_LIVE_TRACE_METRIC_ENTRY_TYPE_FRAME

◆ SceRazorLiveTraceMetricJobType

enum SceRazorLiveTraceMetricJobType

Enumeration for the gpu live results job types.

Enumerator
SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_FIRMWARE
SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_VERTEX1
SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_FRAGMENT1
SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_VERTEX2
SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_FRAGMENT2
SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_VERTEX3
SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_FRAGMENT3
SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_VERTEX0
SCE_RAZOR_LIVE_TRACE_METRIC_JOB_TYPE_FRAGMENT0

Function Documentation

◆ VITASDK_BUILD_ASSERT_EQ() [1/12]

VITASDK_BUILD_ASSERT_EQ	(	0x28	,
		SceRazorGpuLiveResultInfo
	)

◆ VITASDK_BUILD_ASSERT_EQ() [2/12]

VITASDK_BUILD_ASSERT_EQ	(	8	,
		SceRazorGpuLiveEntryHeader
	)

◆ VITASDK_BUILD_ASSERT_EQ() [3/12]

VITASDK_BUILD_ASSERT_EQ	(	4	,
		SceRazorGpuLiveEntryJobVertexValues1
	)

◆ VITASDK_BUILD_ASSERT_EQ() [4/12]

VITASDK_BUILD_ASSERT_EQ	(	0xC	,
		SceRazorGpuLiveEntryJobFragmentValues1
	)

◆ VITASDK_BUILD_ASSERT_EQ() [5/12]

VITASDK_BUILD_ASSERT_EQ	(	0x10	,
		SceRazorGpuLiveEntryJobVertexValues2
	)

◆ VITASDK_BUILD_ASSERT_EQ() [6/12]

VITASDK_BUILD_ASSERT_EQ	(	0xC	,
		SceRazorGpuLiveEntryJobFragmentValues2
	)

◆ VITASDK_BUILD_ASSERT_EQ() [7/12]

VITASDK_BUILD_ASSERT_EQ	(	4	,
		SceRazorGpuLiveEntryJobVertexValues3
	)

◆ VITASDK_BUILD_ASSERT_EQ() [8/12]

VITASDK_BUILD_ASSERT_EQ	(	4	,
		SceRazorGpuLiveEntryJobFragmentValues3
	)

◆ VITASDK_BUILD_ASSERT_EQ() [9/12]

VITASDK_BUILD_ASSERT_EQ	(	0x54	,
		SceRazorGpuLiveEntryJobValues
	)

◆ VITASDK_BUILD_ASSERT_EQ() [10/12]

VITASDK_BUILD_ASSERT_EQ	(	0x80	,
		SceRazorGpuLiveEntryJob
	)

◆ VITASDK_BUILD_ASSERT_EQ() [11/12]

VITASDK_BUILD_ASSERT_EQ	(	0x18	,
		SceRazorGpuLiveEntryParameterBuffer
	)

◆ VITASDK_BUILD_ASSERT_EQ() [12/12]

VITASDK_BUILD_ASSERT_EQ	(	0x20	,
		SceRazorGpuLiveEntryFrame
	)

◆ sceRazorGpuLiveSetMetricsGroup()

int sceRazorGpuLiveSetMetricsGroup ( uint32_t metrics )

Sets a metrics group to use for gpu live debugging.

Parameters

[in] metrics - The metrics group to use (One of SceRazorGpuLiveMetricsGroup)

Returns: 0, <0 on error.

◆ sceRazorGpuLiveSetBuffer()

int sceRazorGpuLiveSetBuffer	(	void *	buffer,
		SceSize	buf_size,
		SceRazorGpuLiveResultInfo *	results
	)

Sets the buffer in which to store gpu live debugging results for the current frame.