Skip to content

PythonQt.QtGui.QOpenGLBuffer · declarations 001

Back to PythonQt.QtGui.QOpenGLBuffer

DynamicCopy instance-attribute

DynamicCopy: Any

DynamicDraw instance-attribute

DynamicDraw: Any

DynamicRead instance-attribute

DynamicRead: Any

IndexBuffer instance-attribute

IndexBuffer: Any

PixelPackBuffer instance-attribute

PixelPackBuffer: Any

PixelUnpackBuffer instance-attribute

PixelUnpackBuffer: Any

RangeAccessFlag instance-attribute

RangeAccessFlag: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

RangeFlushExplicit instance-attribute

RangeFlushExplicit: Any

RangeInvalidate instance-attribute

RangeInvalidate: Any

RangeInvalidateBuffer instance-attribute

RangeInvalidateBuffer: Any

RangeRead instance-attribute

RangeRead: Any

RangeUnsynchronized instance-attribute

RangeUnsynchronized: Any

RangeWrite instance-attribute

RangeWrite: Any

StaticCopy instance-attribute

StaticCopy: Any

StaticDraw instance-attribute

StaticDraw: Any

StaticRead instance-attribute

StaticRead: Any

StreamCopy instance-attribute

StreamCopy: Any

StreamDraw instance-attribute

StreamDraw: Any

StreamRead instance-attribute

StreamRead: Any

UsagePattern instance-attribute

UsagePattern: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

VertexBuffer instance-attribute

VertexBuffer: Any

allocate

allocate(data: Any, count: int) -> None

X.allocate(data, count)

Supplemental documentation: Qt 5 reference:

void QOpenGLBuffer::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 QOpenGLBuffer::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/qopenglbuffer.html#allocate

bind

bind() -> bool

X.bind() -> bool

Supplemental documentation: Qt 5 reference:

bool QOpenGLBuffer::bind()

Binds the buffer associated with this object to the current OpenGL context. Returns false if binding was not possible, usually because type() is not supported on this OpenGL implementation.

The buffer must be bound to the same QOpenGLContext current when create() was called, or to another QOpenGLContext 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/qopenglbuffer.html#bind

bufferId

bufferId() -> int

X.bufferId() -> int

Supplemental documentation: Qt 5 reference:

GLuint QOpenGLBuffer::bufferId() const

Returns the OpenGL 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/qopenglbuffer.html#bufferId

create

create() -> bool

X.create() -> bool

Supplemental documentation: Qt 5 reference:

bool QOpenGLBuffer::create()

Creates the buffer object in the OpenGL server. Returns true if the object was created; false otherwise.

This function must be called with a current QOpenGLContext. 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 OpenGL implementation does not support buffers, or there is no current QOpenGLContext.

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/qopenglbuffer.html#create

destroy

destroy() -> None

X.destroy()

Supplemental documentation: Qt 5 reference:

void QOpenGLBuffer::destroy()

Destroys this buffer object, including the storage being used in the OpenGL 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/qopenglbuffer.html#destroy

isCreated

isCreated() -> bool

X.isCreated() -> bool

Supplemental documentation: Qt 5 reference:

bool QOpenGLBuffer::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/qopenglbuffer.html#isCreated

map

map(access: Any) -> int

X.map(access)

Supplemental documentation: Qt 5 reference:

void *QOpenGLBuffer::map(QOpenGLBuffer::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.

Note: This function is only supported under OpenGL ES 2.0 or earlier if the GL_OES_mapbuffer extension is present.

Note: On OpenGL ES 3.0 and newer, or, in case if desktop OpenGL, if GL_ARB_map_buffer_range is supported, this function uses glMapBufferRange instead of glMapBuffer.

See also unmap(), create(), bind(), and mapRange().

Upstream PySide2 reference signatures (binding differences may apply):

map(self, access: PySide2.QtGui.QOpenGLBuffer.Access) -> int

Source: https://doc.qt.io/archives/qt-5.15/qopenglbuffer.html#map

operator_assign

operator_assign(other: Any) -> Any

X.operator_assign(other) -> PythonQt.QtGui.QOpenGLBuffer

read

read(offset: int, data: int, count: int) -> bool

X.read(offset, data, count) -> bool

Supplemental documentation: Qt 5 reference:

bool QOpenGLBuffer::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.

See also write() and bind().

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/qopenglbuffer.html#read

release

release() -> None

X.release()

Supplemental documentation: Qt 5 reference:

void QOpenGLBuffer::release()

Releases the buffer associated with this object from the current OpenGL context.

This function must be called with the same QOpenGLContext current as when bind() was called on the buffer.

See also bind().

[static] void QOpenGLBuffer::release(QOpenGLBuffer::Type type)

Releases the buffer associated with type in the current QOpenGLContext.

This function is a direct call to glBindBuffer(type, 0) for use when the caller does not know which QOpenGLBuffer has been bound to the context but wants to make sure that it is released.

    QOpenGLBuffer::release(QOpenGLBuffer::VertexBuffer);

Upstream PySide2 reference signatures (binding differences may apply):

release(self) -> None
release(type: PySide2.QtGui.QOpenGLBuffer.Type) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopenglbuffer.html#release

setUsagePattern

setUsagePattern(value: Any) -> None

X.setUsagePattern(value)

Supplemental documentation: Qt 5 reference:

void QOpenGLBuffer::setUsagePattern(QOpenGLBuffer::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.QtGui.QOpenGLBuffer.UsagePattern) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopenglbuffer.html#setUsagePattern

size

size() -> int

X.size() -> int

Supplemental documentation: Qt 5 reference:

int QOpenGLBuffer::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/qopenglbuffer.html#size

type

type() -> Any

X.type()

Supplemental documentation: Qt 5 reference:

QOpenGLBuffer::Type QOpenGLBuffer::type() const

Returns the type of buffer represented by this object.

Upstream PySide2 reference signatures (binding differences may apply):

type(self) -> PySide2.QtGui.QOpenGLBuffer.Type

Source: https://doc.qt.io/archives/qt-5.15/qopenglbuffer.html#type

unmap

unmap() -> bool

X.unmap() -> bool

Supplemental documentation: Qt 5 reference:

bool QOpenGLBuffer::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().

Note: This function is only supported under OpenGL ES 2.0 and earlier 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/qopenglbuffer.html#unmap

usagePattern

usagePattern() -> Any

X.usagePattern()

Supplemental documentation: Qt 5 reference:

QOpenGLBuffer::UsagePattern QOpenGLBuffer::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.QtGui.QOpenGLBuffer.UsagePattern

Source: https://doc.qt.io/archives/qt-5.15/qopenglbuffer.html#usagePattern

write

write(offset: int, data: int, count: int) -> None

X.write(offset, data, count)

Supplemental documentation: Qt 5 reference:

void QOpenGLBuffer::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/qopenglbuffer.html#write