purego: clarify SyscallN usage (#300)

It was unclear how to properly use this function. Add some clarification.

JupiterRider/purego-sdl3#4 (comment)

1 file · +3 -0

M syscall.go +3 -0


@@ -27,6 +27,9 @@ type syscall15Args struct {
27	27		// There is an internal maximum number of arguments that SyscallN can take. It panics
28	28		// when the maximum is exceeded. It returns the result and the libc error code if there is one.
29	29		//
	30	+	// In order to call this function properly make sure to follow all the rules specified in [unsafe.Pointer]
	31	+	// especially point 4.
	32	+	//
30	33		// NOTE: SyscallN does not properly call functions that have both integer and float parameters.
31	34		// See discussion comment https://github.com/ebiten/purego/pull/1#issuecomment-1128057607
32	35		// for an explanation of why that is.


@@ -27,6 +27,9 @@ type syscall15Args struct {
27	// There is an internal maximum number of arguments that SyscallN can take. It panics	27		// There is an internal maximum number of arguments that SyscallN can take. It panics
28	// when the maximum is exceeded. It returns the result and the libc error code if there is one.	28		// when the maximum is exceeded. It returns the result and the libc error code if there is one.
29	//	29		//
		30	+	// In order to call this function properly make sure to follow all the rules specified in [unsafe.Pointer]
		31	+	// especially point 4.
		32	+	//
30	// NOTE: SyscallN does not properly call functions that have both integer and float parameters.	33		// NOTE: SyscallN does not properly call functions that have both integer and float parameters.
31	// See discussion comment https://github.com/ebiten/purego/pull/1#issuecomment-1128057607	34		// See discussion comment https://github.com/ebiten/purego/pull/1#issuecomment-1128057607
32	// for an explanation of why that is.	35		// for an explanation of why that is.