PythonQt.QtOpenGL.QGLBuffer · declarations 001
Back to PythonQt.QtOpenGL.QGLBuffer
allocate
allocate(data: Any, count: int) -> None
X.allocate(data, count)
Supplemental documentation: Qt 5 reference:
void QGLBuffer::allocate(const void *data, int count)
Allocates count bytes of space to the buffer, initialized to the contents of data. Any previous contents will be removed.
It is assumed that create() has been called on this buffer and that it has been bound to the current context.
See also create(), read(), and write().
void QGLBuffer::allocate(int count)
This is an overloaded function.
Allocates count bytes of space to the buffer. Any previous contents will be removed.
It is assumed that create() has been called on this buffer and that it has been bound to the current context.
See also create() and write().
Upstream PySide2 reference signatures (binding differences may apply):
allocate(self, count: int) -> None
allocate(self, data: int, count: int=...) -> None
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#allocate
bind
bind() -> bool
X.bind() -> bool
Supplemental documentation: Qt 5 reference:
bool QGLBuffer::bind()
Binds the buffer associated with this object to the current GL context. Returns false
if binding was not possible, usually because
type() is not supported on
this GL implementation.
The buffer must be bound to the same QGLContext current when create() was called, or to another QGLContext that is sharing with it. Otherwise, false will be returned from this function.
See also release() and create().
Upstream PySide2 reference signatures (binding differences may apply):
bind(self) -> bool
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#bind
bufferId
bufferId() -> int
X.bufferId() -> int
Supplemental documentation: Qt 5 reference:
GLuint QGLBuffer::bufferId() const
Returns the GL identifier associated with this buffer; zero if the buffer has not been created.
See also isCreated().
Upstream PySide2 reference signatures (binding differences may apply):
bufferId(self) -> int
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#bufferId
create
create() -> bool
X.create() -> bool
Supplemental documentation: Qt 5 reference:
bool QGLBuffer::create()
Creates the buffer object in the GL server. Returns true if the object was created;
false otherwise.
This function must be called with a current QGLContext. The buffer will be bound to and can only be used in that context (or any other context that is shared with it).
This function will return false if the GL implementation does not support buffers, or there is no current QGLContext.
See also isCreated(), allocate(), write(), and destroy().
Upstream PySide2 reference signatures (binding differences may apply):
create(self) -> bool
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#create
destroy
destroy() -> None
X.destroy()
Supplemental documentation: Qt 5 reference:
void QGLBuffer::destroy()
Destroys this buffer object, including the storage being used in the GL server. All references to the buffer will become invalid.
Upstream PySide2 reference signatures (binding differences may apply):
destroy(self) -> None
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#destroy
isCreated
isCreated() -> bool
X.isCreated() -> bool
Supplemental documentation: Qt 5 reference:
bool QGLBuffer::isCreated() const
Returns true if this buffer has been created; false otherwise.
See also create() and destroy().
Upstream PySide2 reference signatures (binding differences may apply):
isCreated(self) -> bool
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#isCreated
map
map(access: Any) -> int
X.map(access)
Supplemental documentation: Qt 5 reference:
void *QGLBuffer::map(QGLBuffer::Access access)
Maps the contents of this buffer into the application's memory space and returns a pointer to it. Returns null if memory mapping is not possible. The access parameter indicates the type of access to be performed.
It is assumed that create() has been called on this buffer and that it has been bound to the current context.
This function is only supported under OpenGL/ES if the GL_OES_mapbuffer extension is
present.
See also unmap(), create(), and bind().
Upstream PySide2 reference signatures (binding differences may apply):
map(self, access: PySide2.QtOpenGL.QGLBuffer.Access) -> int
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#map
operator_assign
operator_assign(other: Any) -> Any
X.operator_assign(other) -> PythonQt.QtOpenGL.QGLBuffer
read
read(offset: int, data: int, count: int) -> bool
X.read(offset, data, count) -> bool
Supplemental documentation: Qt 5 reference:
bool QGLBuffer::read(int offset, void *data, int count)
Reads the count bytes in this buffer starting at offset into data. Returns true
on success; false if reading from the buffer is not supported. Buffer reading is not
supported under OpenGL/ES.
It is assumed that this buffer has been bound to the current context.
Upstream PySide2 reference signatures (binding differences may apply):
read(self, offset: int, data: int, count: int) -> bool
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#read
release
release() -> None
X.release()
Supplemental documentation: Qt 5 reference:
void QGLBuffer::release()
Releases the buffer associated with this object from the current GL context.
This function must be called with the same QGLContext current as when bind() was called on the buffer.
See also bind().
[static] void QGLBuffer::release(QGLBuffer::Type type)
Releases the buffer associated with type in the current QGLContext.
This function is a direct call to glBindBuffer(type, 0) for use when the caller does
not know which QGLBuffer has been
bound to the context but wants to make sure that it is released.
QGLBuffer::release(QGLBuffer::VertexBuffer);
Upstream PySide2 reference signatures (binding differences may apply):
release(self) -> None
release(type: PySide2.QtOpenGL.QGLBuffer.Type) -> None
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#release
setUsagePattern
setUsagePattern(value: Any) -> None
X.setUsagePattern(value)
Supplemental documentation: Qt 5 reference:
void QGLBuffer::setUsagePattern(QGLBuffer::UsagePattern value)
Sets the usage pattern for this buffer object to value. This function must be called before allocate() or write().
See also usagePattern(), allocate(), and write().
Upstream PySide2 reference signatures (binding differences may apply):
setUsagePattern(self, value: PySide2.QtOpenGL.QGLBuffer.UsagePattern) -> None
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#setUsagePattern
size
size() -> int
X.size() -> int
Supplemental documentation: Qt 5 reference:
int QGLBuffer::size() const
Returns the size of the data in this buffer, for reading operations. Returns -1 if fetching the buffer size is not supported, or the buffer has not been created.
It is assumed that this buffer has been bound to the current context.
See also isCreated() and bind().
Upstream PySide2 reference signatures (binding differences may apply):
size(self) -> int
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#size
type
type() -> Any
X.type()
Supplemental documentation: Qt 5 reference:
QGLBuffer::Type QGLBuffer::type() const
Returns the type of buffer represented by this object.
Upstream PySide2 reference signatures (binding differences may apply):
type(self) -> PySide2.QtOpenGL.QGLBuffer.Type
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#type
unmap
unmap() -> bool
X.unmap() -> bool
Supplemental documentation: Qt 5 reference:
bool QGLBuffer::unmap()
Unmaps the buffer after it was mapped into the application's memory space with a
previous call to map(). Returns
true if the unmap succeeded; false otherwise.
It is assumed that this buffer has been bound to the current context, and that it was previously mapped with map().
This function is only supported under OpenGL/ES if the GL_OES_mapbuffer extension is
present.
See also map().
Upstream PySide2 reference signatures (binding differences may apply):
unmap(self) -> bool
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#unmap
usagePattern
usagePattern() -> Any
X.usagePattern()
Supplemental documentation: Qt 5 reference:
QGLBuffer::UsagePattern QGLBuffer::usagePattern() const
Returns the usage pattern for this buffer object. The default value is StaticDraw.
See also setUsagePattern().
Upstream PySide2 reference signatures (binding differences may apply):
usagePattern(self) -> PySide2.QtOpenGL.QGLBuffer.UsagePattern
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#usagePattern
write
write(offset: int, data: int, count: int) -> None
X.write(offset, data, count)
Supplemental documentation: Qt 5 reference:
void QGLBuffer::write(int offset, const void *data, int count)
Replaces the count bytes of this buffer starting at offset with the contents of data. Any other bytes in the buffer will be left unmodified.
It is assumed that create() has been called on this buffer and that it has been bound to the current context.
See also create(), read(), and allocate().
Upstream PySide2 reference signatures (binding differences may apply):
write(self, offset: int, data: int, count: int=...) -> None
Source: https://doc.qt.io/archives/qt-5.15/qglbuffer.html#write