pub struct Buffer<T>{ /* private fields */ }
Expand description
Represents a view of a buffer.
Implementations§
source§impl<T> Buffer<T>
impl<T> Buffer<T>
sourcepub fn new<F>(
facade: &F,
data: &T,
ty: BufferType,
mode: BufferMode
) -> Result<Buffer<T>, BufferCreationError>
pub fn new<F>( facade: &F, data: &T, ty: BufferType, mode: BufferMode ) -> Result<Buffer<T>, BufferCreationError>
Builds a new buffer containing the given data. The size of the buffer is equal to the size of the data.
sourcepub fn empty_unsized<F>(
facade: &F,
ty: BufferType,
size: usize,
mode: BufferMode
) -> Result<Buffer<T>, BufferCreationError>
pub fn empty_unsized<F>( facade: &F, ty: BufferType, size: usize, mode: BufferMode ) -> Result<Buffer<T>, BufferCreationError>
Builds a new buffer of the given size.
sourcepub fn get_context(&self) -> &Rc<Context>
pub fn get_context(&self) -> &Rc<Context>
Returns the context corresponding to this buffer.
sourcepub fn is_persistent(&self) -> bool
pub fn is_persistent(&self) -> bool
Returns true if this buffer uses persistent mapping.
sourcepub fn write(&self, data: &T)
pub fn write(&self, data: &T)
Uploads some data in this buffer.
Implementation
- For persistent-mapped buffers, waits untils the data is no longer used by the GPU then memcpies the data to the mapping.
- For immutable buffers, creates a temporary buffer that contains the data then calls
glCopyBufferSubData
to copy from the temporary buffer to the real one. - For other types, calls
glBufferSubData
.
Panic
Panics if the length of data
is different from the length of this buffer.
sourcepub fn invalidate(&self)
pub fn invalidate(&self)
Invalidates the content of the buffer. The data becomes undefined.
You should call this if you only use parts of a buffer. For example if you want to use the first half of the buffer, you invalidate the whole buffer then write the first half.
This operation is a no-op if the backend doesn’t support it and for persistent-mapped buffers.
Implementation
Calls glInvalidateBufferData
if supported. Otherwise, calls glBufferData
with a null
pointer for data. If glBufferStorage
has been used to create the buffer and
glInvalidateBufferData
is not supported, does nothing.
sourcepub fn map(&mut self) -> Mapping<'_, T>
pub fn map(&mut self) -> Mapping<'_, T>
Maps the buffer in memory for both reading and writing.
Implementation
- For persistent-mapped buffers, waits until the data is no longer accessed by the GPU then returns a pointer to the existing mapping.
- For immutable buffers, creates a temporary buffer containing the data of the buffer and maps it. When the mapping object is destroyed, copies the content of the temporary buffer to the real buffer.
- For other types, calls
glMapBuffer
orglMapSubBuffer
.
sourcepub fn map_read(&mut self) -> ReadMapping<'_, T>
pub fn map_read(&mut self) -> ReadMapping<'_, T>
Maps the buffer in memory for reading.
Implementation
- For persistent-mapped buffers, waits until the data is no longer accessed by the GPU then returns a pointer to the existing mapping.
- For immutable buffers, creates a temporary buffer containing the data of the buffer and maps it.
- For other types, calls
glMapBuffer
orglMapSubBuffer
.
sourcepub fn map_write(&mut self) -> WriteMapping<'_, T>
pub fn map_write(&mut self) -> WriteMapping<'_, T>
Maps the buffer in memory for writing only.
Implementation
- For persistent-mapped buffers, waits until the data is no longer accessed by the GPU then returns a pointer to the existing mapping.
- For immutable buffers, creates a temporary buffer and maps it. When the mapping object is destroyed, copies the content of the temporary buffer to the real buffer.
- For other types, calls
glMapBuffer
orglMapSubBuffer
.
sourcepub fn copy_to<'a, S>(&self, target: S) -> Result<(), CopyError>where
S: Into<BufferSlice<'a, T>>,
T: 'a,
pub fn copy_to<'a, S>(&self, target: S) -> Result<(), CopyError>where
S: Into<BufferSlice<'a, T>>,
T: 'a,
Copies the content of the buffer to another buffer.
Panic
Panics if T
is unsized and the other buffer is too small.
sourcepub unsafe fn slice_custom<R>(&self, f: Field<R>) -> BufferSlice<'_, R>where
R: Content,
pub unsafe fn slice_custom<R>(&self, f: Field<R>) -> BufferSlice<'_, R>where
R: Content,
Builds a slice that contains an element from inside the buffer.
This method builds an object that represents a slice of the buffer. No actual operation OpenGL is performed.
Example
#[derive(Copy, Clone)]
struct BufferContent {
value1: u16,
value2: u16,
}
let slice = unsafe { buffer.slice_custom(glium::field!(BufferContent, value2)) };
sourcepub unsafe fn slice_custom_mut<R>(
&mut self,
f: Field<R>
) -> BufferMutSlice<'_, R>where
R: Content,
pub unsafe fn slice_custom_mut<R>(
&mut self,
f: Field<R>
) -> BufferMutSlice<'_, R>where
R: Content,
Same as slice_custom
but returns a mutable slice.
This method builds an object that represents a slice of the buffer. No actual operation OpenGL is performed.
sourcepub fn as_slice(&self) -> BufferSlice<'_, T>
pub fn as_slice(&self) -> BufferSlice<'_, T>
Builds a slice containing the whole subbuffer.
This method builds an object that represents a slice of the buffer. No actual operation OpenGL is performed.
sourcepub fn as_mut_slice(&mut self) -> BufferMutSlice<'_, T>
pub fn as_mut_slice(&mut self) -> BufferMutSlice<'_, T>
Builds a slice containing the whole subbuffer.
This method builds an object that represents a slice of the buffer. No actual operation OpenGL is performed.
sourcepub fn as_slice_any(&self) -> BufferAnySlice<'_>
pub fn as_slice_any(&self) -> BufferAnySlice<'_>
Builds a slice-any containing the whole subbuffer.
This method builds an object that represents a slice of the buffer. No actual operation OpenGL is performed.
source§impl<T> Buffer<T>
impl<T> Buffer<T>
sourcepub fn empty<F>(
facade: &F,
ty: BufferType,
mode: BufferMode
) -> Result<Buffer<T>, BufferCreationError>
pub fn empty<F>( facade: &F, ty: BufferType, mode: BufferMode ) -> Result<Buffer<T>, BufferCreationError>
Builds a new buffer of the given size.
source§impl<T> Buffer<[T]>
impl<T> Buffer<[T]>
sourcepub fn empty_array<F>(
facade: &F,
ty: BufferType,
len: usize,
mode: BufferMode
) -> Result<Buffer<[T]>, BufferCreationError>
pub fn empty_array<F>( facade: &F, ty: BufferType, len: usize, mode: BufferMode ) -> Result<Buffer<[T]>, BufferCreationError>
Builds a new buffer of the given size.
source§impl<T> Buffer<[T]>where
T: PixelValue,
impl<T> Buffer<[T]>where
T: PixelValue,
sourcepub fn read_as_texture_1d<S>(&self) -> Result<S, ReadError>where
S: Texture1dDataSink<T>,
pub fn read_as_texture_1d<S>(&self) -> Result<S, ReadError>where
S: Texture1dDataSink<T>,
Reads the content of the buffer.
Trait Implementations§
source§impl<'a, T> AsUniformValue for &'a Buffer<T>
impl<'a, T> AsUniformValue for &'a Buffer<T>
source§fn as_uniform_value(&self) -> UniformValue<'_>
fn as_uniform_value(&self) -> UniformValue<'_>
UniformValue
.source§impl<'a, T> From<&'a Buffer<T>> for BufferSlice<'a, T>
impl<'a, T> From<&'a Buffer<T>> for BufferSlice<'a, T>
source§fn from(b: &'a Buffer<T>) -> BufferSlice<'a, T>
fn from(b: &'a Buffer<T>) -> BufferSlice<'a, T>
source§impl<'a, T> From<&'a mut Buffer<T>> for BufferMutSlice<'a, T>
impl<'a, T> From<&'a mut Buffer<T>> for BufferMutSlice<'a, T>
source§fn from(b: &'a mut Buffer<T>) -> BufferMutSlice<'a, T>
fn from(b: &'a mut Buffer<T>) -> BufferMutSlice<'a, T>
source§impl<'a, T> From<&'a mut Buffer<T>> for BufferSlice<'a, T>
impl<'a, T> From<&'a mut Buffer<T>> for BufferSlice<'a, T>
source§fn from(b: &'a mut Buffer<T>) -> BufferSlice<'a, T>
fn from(b: &'a mut Buffer<T>) -> BufferSlice<'a, T>
Auto Trait Implementations§
impl<T> !RefUnwindSafe for Buffer<T>
impl<T> !Send for Buffer<T>
impl<T> !Sync for Buffer<T>
impl<T: ?Sized> Unpin for Buffer<T>where
T: Unpin,
impl<T> !UnwindSafe for Buffer<T>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.