Struct thindx::d3d9::Lock

#[repr(transparent)]
pub struct Lock(_);

[docs.microsoft.com] DWORD / D3DLOCK_*

A combination of zero or more locking options that describe the type of lock to perform.

Implementations

impl Lock

pub const fn zeroed() -> Self

Initialize to 0.

pub const fn none() -> Self

Initialize to 0.

pub const fn from_unchecked(d3d: u32) -> Self

Convert from an underlying [winapi] D3D... type. This is probably safe… probably…

pub const fn into_inner(self) -> u32

Convert back into an underlying [winapi] D3D... type.

impl Lock

pub const None: Lock = Lock(0)

No lock flags

pub const Discard: Lock = Lock(D3DLOCK_DISCARD)

The application discards all memory within the locked region. For vertex and index buffers, the entire buffer will be discarded. This option is only valid when the resource is created with [Usage::Dynamic].

pub const DoNotWait: Lock = Lock(D3DLOCK_DONOTWAIT)

Allows an application to gain back CPU cycles if the driver cannot lock the surface immediately. If this flag is set and the driver cannot lock the surface immediately, the lock call will return D3DERR::WASSTILLDRAWING. This flag can only be used when locking a surface created using [IDirect3DDevice9Ext::create_offscreen_plain_surface], [IDirect3DDevice9Ext::create_render_target], or [IDirect3DDevice9Ext::create_depth_stencil_surface]. This flag can also be used with a back buffer.

pub const NoDirtyUpdate: Lock = Lock(D3DLOCK_NO_DIRTY_UPDATE)

By default, a lock on a resource adds a dirty region to that resource. This option prevents any changes to the dirty state of the resource. Applications should use this option when they have additional information about the set of regions changed during the lock operation.

pub const NoOverwrite: Lock = Lock(D3DLOCK_NOOVERWRITE)

Indicates that memory that was referred to in a drawing call since the last lock without this flag will not be modified during the lock. This can enable optimizations when the application is appending data to a resource. Specifying this flag enables the driver to return immediately if the resource is in use, otherwise, the driver must finish using the resource before returning from locking.

pub const NoSysLock: Lock = Lock(D3DLOCK_NOSYSLOCK)

The default behavior of a video memory lock is to reserve a system-wide critical section, guaranteeing that no display mode changes will occur for the duration of the lock. This option causes the system-wide critical section not to be held for the duration of the lock.

The lock operation is time consuming, but can enable the system to perform other duties, such as moving the mouse cursor. This option is useful for long-duration locks, such as the lock of the back buffer for software rendering that would otherwise adversely affect system responsiveness.

pub const ReadOnly: Lock = Lock(D3DLOCK_READONLY)

The application will not write to the buffer. This enables resources stored in non-native formats to save the recompression step when unlocking.

Trait Implementations

impl BitOr<Lock> for Lock

type Output = Lock

The resulting type after applying the | operator.

fn bitor(self, other: Self) -> Self

Performs the | operation.

impl BitOrAssign<Lock> for Lock

fn bitor_assign(&mut self, other: Self)

Performs the |= operation.

impl Clone for Lock

fn clone(&self) -> Lock

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Lock

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Lock

fn default() -> Self

Returns the “default value” for a type.

impl From<Lock> for u32

fn from(value: Lock) -> Self

Converts to this type from the input type.

impl Hash for Lock

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Lock

fn cmp(&self, other: &Lock) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Lock> for Lock

fn eq(&self, other: &Lock) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Lock) -> bool

This method tests for !=.

impl PartialOrd<Lock> for Lock

fn partial_cmp(&self, other: &Lock) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Zeroable for Lock

fn zeroed() -> Self

Calls zeroed.

impl Copy for Lock

impl Eq for Lock

impl Pod for Lock

impl StructuralEq for Lock

impl StructuralPartialEq for Lock