GraphicsDevice Public and Private Properties

[epreston]

In this PR, a number of methods where marked as no longer exposed as public in derived classes.

#4013

Is this still the case ?

Specifically:

GraphicsDevice.setIndexBuffer
GraphicsDevice.setVertexBuffer

At the moment, they are not marked as "private" so typedocs is trying to process a few of them.

[mvaligursky]

These two methods are marked as public currently: setIndexBuffer, setVertexBuffer.
So I'm not entirely sure what you are asking here, could you please clarify?

[epreston]

I'm preparing updates for published typedoc documentation.

It fails to create documentation for these with warnings. I did a quick check to determine if it should be documenting them in the first place. I found this PR which suggested they should get an @ignore to stop them from being added to published documentation.

[mvaligursky]

They seem to documented correctly to me here:

engine/src/platform/graphics/graphics-device.js

Lines 520 to 546 in bdf8eac

	/**
	* Sets the current index buffer on the graphics device. On subsequent calls to
	* {@link GraphicsDevice#draw}, the specified index buffer will be used to provide index data
	* for any indexed primitives.
	*
	* @param {import('./index-buffer.js').IndexBuffer} indexBuffer - The index buffer to assign to
	* the device.
	*/
	setIndexBuffer(indexBuffer) {
	// Store the index buffer
	this.indexBuffer = indexBuffer;
	}
	/**
	* Sets the current vertex buffer on the graphics device. On subsequent calls to
	* {@link GraphicsDevice#draw}, the specified vertex buffer(s) will be used to provide vertex
	* data for any primitives.
	*
	* @param {import('./vertex-buffer.js').VertexBuffer} vertexBuffer - The vertex buffer to
	* assign to the device.
	*/
	setVertexBuffer(vertexBuffer) {
	if (vertexBuffer) {
	this.vertexBuffers.push(vertexBuffer);
	}
	}

What warnings are you getting?

[epreston]

The documentation comment links to a draw method which does not exist on the GraphicsDevice base class.

In another thread, we talked about creating the abstract method to satisfy this. I'll update that.

Once fixed, it will appear in public documentation. I want to be sure it should be published.